Skip to main content
Glama

Generate Repository Documentation Tool

generate-repository-documentation

Use this when the user wants one markdown document generated from selected files in an imported repository. After authorization, this state-changing action consumes AI credits and creates a generation using numeric repository_id and selected_files, with optional Space saving that may make the output publicly accessible.

Input Schema

NameRequiredDescriptionDefault
filenameNoOptional generation history filename. Defaults to the selected repository documentation naming pattern.
languageNoOptional human language for the generated repository documentation. Defaults to English.
repository_idYesRequired numeric ID of an already connected/imported repository from the user repository records; do not pass a slug, URL, provider name, or Space repository-link ID.
save_to_spaceNoOptional destination Space page to create from the generated documentation after authorization. The authenticated user must manage the Space.
selected_filesYesRequired repository file paths already selected from the imported repository tree, such as app/Models/User.php or routes/api.php. Use browser guidance if the user still needs to choose files.
additional_instructionsNoOptional customer instructions for documentation tone, scope, examples, framework focus, or project-specific emphasis.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.1/5.0
Behavior5/5

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

Goes well beyond the annotations by disclosing that this is state-changing, requires authorization, consumes AI credits, and that optional Space saving 'may make the output publicly accessible' — a meaningful side-effect warning. This is consistent with readOnlyHint=false and adds genuine behavioral context the annotations cannot convey.

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

Conciseness4/5

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

Two sentences, front-loaded with the 'Use this when...' trigger, with no filler. Slightly dense in the second sentence but every clause (auth, credits, repo_id/selected_files, Space saving public exposure) earns its place.

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

Completeness4/5

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

For a mutation tool with six parameters (including a nested object) and no output schema, the description covers authorization, credit cost, side effects, and the public-accessibility caveat. It lacks any note on return/result format, but absent an output schema this omission is minor.

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

Parameters3/5

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

Schema description coverage is 100%, so all six parameters (including the nested save_to_space object) are already documented in the schema, including the 'numeric repository_id, not a slug/URL' constraint. The description reinforces 'numeric repository_id and selected_files' and the public-access risk of Space saving, but adds little beyond what the schema already provides. Baseline 3 applies.

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

Purpose4/5

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

States a specific verb (generate) and resource (one markdown document from selected files in an imported repository), which is concretely scoped. It implicitly distinguishes itself from full-tree/codebase siblings via 'from selected files,' but never names or contrasts an alternative, so it falls short of the sibling-differentiation needed for a 5.

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

Usage Guidelines4/5

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

The opening 'Use this when the user wants one markdown document generated from selected files in an imported repository' gives explicit, actionable usage context. However, in a crowded space of generate-* siblings (codebase, full-tree, readme, release-notes), it offers no exclusions or guidance on when to pick a different generator.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.