Add tool docs

[ngeorgy]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @ngeorgy, I'm Gemini Code Assist¹! 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 focuses on substantially improving the documentation across various tool packages within the codebase. The changes introduce detailed comments at the package, struct, type, and method levels, providing clearer explanations of each component's purpose, configuration, and behavior. This enhancement aims to make the codebase more understandable and maintainable for developers working with these tools, facilitating quicker onboarding and more efficient code reviews.

Highlights

• Comprehensive Documentation for Tool Packages: Added extensive documentation across various tool packages, including agenttool, exitlooptool, functiontool, geminitool, loadartifactstool, mcptoolset, and the core tool package.
• Clarified Agent Tool Functionality: The agenttool package now includes detailed comments explaining its purpose (allowing agents to call other agents), the Config struct, and the behavior of key methods like Declaration(), Run(), and ProcessRequest().
• Enhanced Core Tool Interfaces: The tool package received significant documentation updates, clearly defining the Tool, Context, and Toolset interfaces, along with their respective methods and their roles in agent interactions.
• Improved Readability and Maintainability: The added comments at package, struct, type, and method levels aim to make the codebase more understandable, facilitating quicker onboarding for new developers and more efficient code reviews.

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. ↩

[gemini-code-assist]

Code Review

This pull request focuses on adding documentation across various tool packages, which significantly improves code clarity. The added comments are generally descriptive and helpful. I've provided a few suggestions to further improve the documentation by adhering to Go conventions, enhancing clarity, and fixing some issues where tool descriptions were not adequate for LLM consumption. Specifically, some tools were returning their names as descriptions, which is not helpful for the model. Overall, this is a valuable contribution to the codebase's maintainability.