gitea_read

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Discloses that operations are safe and GET-only, implying no side effects. Also mentions strict param validation with ValueError. Missing details on authentication or rate limits, but these are likely shared across tools.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

Concise with bullet-point structure, front-loading the purpose. Each sentence provides necessary information without redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers the meta-operation system thoroughly, including help and schema retrieval. Lacks details on error handling beyond validation errors and does not specify output format, but the schema mechanism addresses schema queries.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema has 0% description coverage, but description compensates by explaining the meaning of 'operation' and 'params', including the meta-pattern for listing ops and schemas. Adds value beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

Clearly states 'Gitea read operations — safe, GET-only', specifying the verb (read) and resource (Gitea operations). Distinguishes from sibling tools (admin_read, write, delete, etc.) via the 'safe, GET-only' phrase.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides explicit instructions for using operation='help', 'schema', and specific operation invocations. However, does not explicitly state when to not use this tool vs siblings, though the name and 'safe, GET-only' imply a read-only scope.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.