Skip to main content
Glama
Local Development MCP Server

Local Development MCP Server

by lreb

generate-readme

Generate a README.md template for a project from a project name, description, and optional feature list to start documentation quickly.

Instructions

Generate a README.md template for a project

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "projectName": "<projectName>",
      "description": "<description>"
    },
    "name": "generate-readme"
  }
}

Input Schema

NameRequiredDescriptionDefault
featuresNoKey features
descriptionYesProject description
projectNameYesProject name

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.0

TDQS

C2.8/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full disclosure burden and does not meet it. It never says whether the result is returned as text or written to disk (relevant given the write-file sibling), whether an existing README would be overwritten, or what permissions are needed.

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

Conciseness3/5

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

The single sentence is front-loaded and free of padding, but its brevity reflects under-specification rather than efficient communication. Nothing is wasted, yet very little is delivered.

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

Completeness2/5

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

For a tool with no annotations, no output schema, and an ambiguous write-vs-return behavior, one sentence is not enough. An agent cannot determine the side effects or the shape of the result before invoking it.

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 projectName, description, and features are already documented in the input schema. The description adds no extra meaning such as expected format, length limits, or how features are rendered, so the baseline of 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?

The description names a specific verb and artifact: generating a README.md template for a project. That is clearer than a bare name restatement, but it does not distinguish this tool from the sibling generate-markdown-doc, so an agent cannot tell the two apart on the description alone.

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

Usage Guidelines2/5

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

There is no when-to-use guidance, no prerequisites, and no mention of the obvious alternative generate-markdown-doc. The agent is left to infer the boundary between generic markdown generation and README-specific templating.

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