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.

Input Schema

TableJSON 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

A3.8/5.0
Behavior4/5

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

The description discloses that the action is state-changing, consumes AI credits, and requires authorization, which goes beyond the annotations (readOnlyHint=false, destructiveHint=false). It does not detail all side effects, but the key behavioral aspects are covered.

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

Conciseness5/5

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

The description is two sentences, front-loaded with the primary purpose and followed by behavioral notes. It is concise, clear, and every sentence contributes meaning without unnecessary fluff.

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?

Given the tool's complexity (6 parameters, nested object, no output schema), the description covers the main action, side effects, and authorization requirement. It does not expand on the nested save_to_space object, but the schema description handles that, so the description is sufficiently complete.

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?

The description reiterates that repository_id and selected_files are used and that Space saving is optional, but these details are already present in the schema with 100% coverage. No additional parameter insight is provided, so the baseline score of 3 is appropriate.

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?

The description clearly states that the tool generates one markdown document from selected files in an imported repository. It does not explicitly name sibling tools, but the phrase 'selected files' implicitly differentiates it from whole-tree documentation generators.

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

Usage Guidelines3/5

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

It provides a usage condition ('when the user wants one markdown document generated from selected files'), but does not mention any alternative tools or describe when not to use this tool. The lack of explicit sibling comparison leaves the agent to infer the appropriate context.

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.

Resources