x402-ai-readme
AI Readme: Generate a README with AI.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | Code to process | |
| name | No | Name to process | |
| source | No | Source to process | |
| project | No | Project to process |
AI Readme: Generate a README with AI.
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | Code to process | |
| name | No | Name to process | |
| source | No | Source to process | |
| project | No | Project to process |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden of behavioral disclosure, yet it only reveals that AI is used. It does not state whether an external model call is made, whether output is markdown, how partial inputs are handled, or any cost/latency implications.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
At seven words, the description wastes nothing and front-loads the core action ('Generate a README'). However, the brevity reflects under-specification rather than disciplined conciseness — a tool with four ambiguous parameters and no annotations needs more than one sentence to be useful.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description is inadequate for the tool's complexity: four optional string parameters, no output schema, no annotations, and a dense sibling list. An agent cannot determine what to pass in, what the result looks like, or how this tool differs from x402-readme-gen.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, but the schema descriptions are templated boilerplate — 'Code to process', 'Name to process', 'Source to process', 'Project to process' — offering no real meaning for a README generator. The tool description adds nothing about how the four parameters relate to the generation task, which one is primary, or what format is expected.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource — 'Generate a README' — so an agent can identify the core function. However, the 'AI Readme' prefix merely restates the tool name, and nothing distinguishes this from sibling x402-readme-gen, which appears to serve the identical purpose.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is given on when to use this tool, what inputs are needed, or which alternatives (e.g., x402-readme-gen, x402-ai-summarize) would be more appropriate for related tasks. In a sibling space of over a thousand tools, the absence of any selection criteria leaves the agent to guess.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.