github_export_catalog

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It notes that the tool saves/updates a file, but it does not warn about overwrite behavior, side effects on existing files, or any destructive implications, leaving significant behavioral ambiguity for an agent.

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?

The description is one concise sentence with no redundant clauses. It front-loads the core action and resource before elaborating on content, though 'organized' is mildly redundant filler and the structure is minimal rather than excellent.

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?

The tool has moderate-to-high complexity with five parameters, nested repository objects, merge/overwrite modes, and an alternative parameter name, yet no annotations or output schema. The description does not explain mode behavior, file effects, return values, or when to use the compiled_categories parameter, leaving important operational context missing.

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 description coverage is 100%, so the schema fully documents every parameter and the baseline is 3. The description adds little beyond the schema, mentioning only summaries and tags, which are already covered by the repo object's 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?

The description uses a specific verb ('Save or update') with a clear resource ('organized Markdown catalog file') and explains the file's contents ('grouping repositories by category with summaries and tags'). It is clear enough to differentiate from siblings like get_user_info or list_starred, though it does not explicitly name or contrast any sibling tool.

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?

The description implies usage: when the user wants to persist a categorized Markdown catalog of repositories. However, it gives no explicit when-to-use guidance, no exclusions, and does not explain when this tool should be chosen over related tools like assign_repo_to_lists or create_user_list.

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