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

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.9/5.0
Behavior4/5

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

Annotations cover the safety profile, and the description adds genuinely new context: this is a state-changing action that consumes AI credits and may make output publicly accessible via Space saving. That is real disclosure beyond what readOnlyHint/destructiveHint provide, though rate limits and failure behavior are unstated.

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 trigger condition, then the side effects. It is dense and clause-heavy but every clause carries a fact; no filler.

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 six-parameter, nested-object, no-output-schema tool, the description covers the triggering scenario, required inputs, auth requirement, credit consumption, and public-visibility risk of the optional Space save. Quite complete, with only alternative-selection guidance missing.

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 are already documented in structured fields; the description's mention of numeric repository_id and selected_files only restates the schema. Baseline 3 is correct since the schema does the heavy lifting.

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 gives a specific verb+resource+scope: 'one markdown document generated from selected files in an imported repository.' That distinguishes it from broad siblings like generate-codebase-documentation or generate-repository-readme by scoping output to selected files, though it never names a sibling explicitly.

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?

It states the triggering condition ('Use this when the user wants one markdown document...') and prerequisites (authorization required, credits consumed). It does not, however, say when NOT to use it or which alternative to pick for readme/release-notes style output.

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