Skip to main content
Glama

Generate Repository Readme Tool

generate-repository-readme

Use this when the user asks to generate or refresh a README for an imported repository. After authorization, this state-changing action consumes AI credits, creates a generation, and can save it to a Space, where it may be publicly accessible; it requires the numeric repository_id.

Input Schema

NameRequiredDescriptionDefault
licenseNoOptional license value for the README; required when sections includes License.
filenameNoOptional generation history filename. Defaults to README.md plus the repository name.
languageNoOptional human language for the generated README. Defaults to English.
sectionsNoOptional README sections to include, such as Introduction, Features, Requirements, Installation, Usage, Configuration, Contributing, or License.
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 README after authorization. The authenticated user must manage the Space.
additional_instructionsNoOptional customer instructions for README tone, scope, installation focus, examples, 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?

Annotations only declare readOnlyHint=false, destructiveHint=false and openWorldHint=true; the description adds substantial context beyond that — that it is a state-changing action, consumes AI credits, creates a generation, requires prior authorization, and can publish to a Space where it may be publicly accessible. These are exactly the side effects an agent needs to warn a user about.

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?

A single dense sentence, front-loaded with the trigger and followed by prerequisites and side effects. Every clause carries information, though the packed semicolon structure is slightly heavy to parse.

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

Completeness5/5

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

No output schema exists, and the description covers the authorization requirement, credit consumption, generation creation, and the public-visibility risk of save_to_space — the key facts an agent needs before invoking a mutation tool.

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 the parameter burden is already carried by the structured fields; the description's note that repository_id must be numeric and not a slug/URL/provider name is a restatement of the schema's own description. Baseline 3 applies when 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?

States a specific verb+resource: generate or refresh a README for an imported repository. It is clear what the tool produces, but among the many generate-* siblings (generate-repository-documentation, generate-repository-release-notes, generate-and-add-documentation) it never names which artifact distinguishes it beyond the word README.

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?

Gives an explicit trigger: 'Use this when the user asks to generate or refresh a README for an imported repository.' That is a clear context for invocation, but there are no exclusions or pointers to alternatives for overlapping documentation-generation tools.

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.