Skip to content

docs: Add error categorization docs#2726

Open
duwenxin99 wants to merge 2 commits intomainfrom
err-doc
Open

docs: Add error categorization docs#2726
duwenxin99 wants to merge 2 commits intomainfrom
err-doc

Conversation

@duwenxin99
Copy link
Contributor

No description provided.

@duwenxin99 duwenxin99 requested a review from a team as a code owner March 12, 2026 14:02
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the developer documentation by adding a new section dedicated to error handling within the Toolbox framework. The update clarifies how to categorize and implement different error types, ensuring robust agentic workflows and proper alignment with the Model Context Protocol. This will help developers understand and correctly apply error handling strategies for tools.

Highlights

  • New Documentation Section: Added a comprehensive section on 'Tool Invocation & Error Handling' to DEVELOPER.md.
  • Error Categorization: Introduced a clear distinction between 'Agent Error' (fixable by LLM) and 'Server Error' (requiring developer intervention), aligning with the Model Context Protocol (MCP).
  • Implementation Guidelines: Provided guidelines for implementing Invoke() and ParseParams() methods to return util.ToolboxError, specifying when to use AgentError or ClientServerError.
  • Code Example: Included a Go code example demonstrating how to correctly handle and return AgentError within an Invoke() method.
Changelog
  • DEVELOPER.md
    • Added new documentation section 'Tool Invocation & Error Handling'.
    • Detailed error categorization into Agent Error and Server Error.
    • Provided implementation guidelines for Invoke() and ParseParams() methods.
    • Included a Go code example for error handling.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@duwenxin99 duwenxin99 changed the title add error doc docs: Add error categorization docs Mar 12, 2026
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds important documentation on error handling within the MCP Toolbox. The new section clarifies the distinction between Agent and Server errors, which is crucial for building robust tools. I've identified a few areas in the new documentation that need correction to ensure accuracy and consistency with the existing codebase. Specifically, the example Invoke function has an incorrect signature, the error type names in the categorization table are wrong, and one of the implementation guidelines could be more precise. Please see my detailed comments for suggestions.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 12, 2026

Link Resolution Note

Local links and directory changes work differently on GitHub than on the docsite. You must ensure fixes pass the GitHub check and also work with hugo server.
See Link Checking and Fixing with Lychee for more details.

Summary

Status Count
🔍 Total 45
✅ Successful 39
⏳ Timeouts 0
👻 Excluded 0
❓ Unknown 0
🚫 Errors 1
⛔ Unsupported 0

Errors per input

Errors in DEVELOPER.md

  • [ERROR] https://play.dgraph.io/ | Network error: Connection failed. Check network connectivity and firewall settings (error sending request for url (https://play.dgraph.io/)): Connection failed. Check network connectivity and firewall settings

Full Github Actions output

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants