docs: use helper functions and return error as result #322

pottekkat · 2025-05-24T05:44:24Z

Description

I was checking for inconsistencies in the documentation with recent updates to the SDK. This was the only one I could find. The rest looks good.

Type of Change

Bug fix (non-breaking change that fixes an issue)
New feature (non-breaking change that adds functionality)
MCP spec compatibility implementation
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation update
Code refactoring (no functional changes)
Performance improvement
Tests only (no functional changes)
Other (please describe):

Checklist

My code follows the code style of this project
I have performed a self-review of my own code
I have added tests that prove my fix is effective or that my feature works
I have updated the documentation accordingly

Summary by CodeRabbit

Documentation
- Updated the Table of Contents in the README to include new subsections under "Extras" and expanded "Session Management" topics.
- Removed the "Contributing" link from the Table of Contents.

Signed-off-by: Navendu Pottekkat <navendu@apache.org>

coderabbitai · 2025-05-24T05:44:36Z

Walkthrough

The helloHandler function was updated to use request.RequireString("name") for argument validation and to return MCP tool result errors for invalid input. The README's Table of Contents was revised to include additional subsections under "Extras" and to remove the "Contributing" link.

Changes

Files / Groups	Change Summary
README.md	Updated Table of Contents: added subsections under "Extras" and removed "Contributing" link.
.../helloHandler implementation	Replaced manual type assertion with `request.RequireString("name")`; updated error handling to MCP style.

Suggested labels

documentation

Suggested reviewers

robert-jackson-glean

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 17af676 and 8f4764c.

📒 Files selected for processing (1)

README.md (2 hunks)

🧰 Additional context used

🪛 LanguageTool

README.md

[grammar] ~100-~100: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...ic-session-handling) - Per-Session Tools - Tool Filtering - [Work...

(REPEATED_VERBS)

🪛 markdownlint-cli2 (0.17.2)

README.md

97-97: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

98-98: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

99-99: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

100-100: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

101-101: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

102-102: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

🔇 Additional comments (2)

README.md (2)

61-63: Consistent use of helper functions and error handling
The updated helloHandler now correctly uses request.RequireString("name") for validation and returns an MCP tool error result (mcp.NewToolResultError(err.Error())) instead of a raw Go error. This aligns with the SDK’s error-handling pattern.

97-102: TOC updated to include new Extras subsections
The Table of Contents now reflects the added “Transports” and expanded “Session Management” sections. All anchor links correspond to existing headings, and removing “Contributing” streamlines the TOC.

🧰 Tools

🪛 LanguageTool

[grammar] ~100-~100: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...ic-session-handling) - Per-Session Tools - Tool Filtering - [Work...

(REPEATED_VERBS)

🪛 markdownlint-cli2 (0.17.2)

97-97: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

98-98: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

99-99: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

100-100: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

101-101: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

102-102: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

pottekkat · 2025-05-24T05:46:32Z

README.md

-    name, ok := request.GetArguments()["name"].(string)
-    if !ok {
-        return nil, errors.New("name must be a string")
+    name, err := request.RequireString("name")


Use the helper function. That's how we would want developers to use the SDK.

pottekkat · 2025-05-24T05:48:16Z

README.md

-        return nil, errors.New("name must be a string")
+    name, err := request.RequireString("name")
+    if err != nil {
+        return mcp.NewToolResultError(err.Error()), nil


Errors should be returned in the result so that the MCP client/host/LLM can use it as feedback. We follow that in other examples and we should do that here too.

pottekkat · 2025-05-24T05:48:16Z

README.md

  - [Prompts](#prompts)
 - [Examples](#examples)
 - [Extras](#extras)
+  - [Transports](#transports)
  - [Session Management](#session-management)
+    - [Basic Session Handling](#basic-session-handling)
+    - [Per-Session Tools](#per-session-tools)
+    - [Tool Filtering](#tool-filtering)
+    - [Working with Context](#working-with-context)
  - [Request Hooks](#request-hooks)
  - [Tool Handler Middleware](#tool-handler-middleware)
  - [Regenerating Server Code](#regenerating-server-code)
- [Contributing](/CONTRIBUTING.md)


Apparently the ToC was not up to date, my formatter automatically formatted it for me on save.

docs: use helper functions and return error as result

8f4764c

Signed-off-by: Navendu Pottekkat <navendu@apache.org>

pottekkat commented May 24, 2025

View reviewed changes

ezynda3 merged commit e028081 into mark3labs:main May 24, 2025
4 checks passed

pottekkat deleted the docs/fix-code/1 branch May 24, 2025 13:25

coderabbitai bot mentioned this pull request May 31, 2025

feat(mcp): add NewToolResultErrorf #357

Merged

13 tasks

coderabbitai bot mentioned this pull request Jun 21, 2025

Fix docs #430

Merged

16 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: use helper functions and return error as result #322

docs: use helper functions and return error as result #322

Uh oh!

pottekkat commented May 24, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented May 24, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

pottekkat May 24, 2025

Uh oh!

pottekkat May 24, 2025

Uh oh!

pottekkat May 24, 2025

Uh oh!

Uh oh!

Uh oh!

docs: use helper functions and return error as result #322

docs: use helper functions and return error as result #322

Uh oh!

Conversation

pottekkat commented May 24, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of Change

Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented May 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Suggested labels

Suggested reviewers

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

pottekkat May 24, 2025

Choose a reason for hiding this comment

Uh oh!

pottekkat May 24, 2025

Choose a reason for hiding this comment

Uh oh!

pottekkat May 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

pottekkat commented May 24, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 24, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)