x402-ai-readme
AI Readme: Generate a README with AI.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | ||
| name | No | ||
| source | No | ||
| project | No |
AI Readme: Generate a README with AI.
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | ||
| name | No | ||
| source | No | ||
| project | No |
Changes observed during successful MCP inspections.
Input schema / properties / code / descriptionRemoved value: -"Code to process"Input schema / properties / name / descriptionRemoved value: -"Name to process"Input schema / properties / project / descriptionRemoved value: -"Project to process"Input schema / properties / source / descriptionRemoved value: -"Source to process"Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full behavioral burden, and it discloses nothing: not what inputs are required, what the AI does with them, whether the call is billed/rate-limited, nor what is returned. 'Generate ... with AI' hints at model invocation but gives no operational context.
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?
It is a single short sentence, so nothing is bloated, but the 'AI Readme:' prefix merely restates the tool name and the tool id. This is under-specification masquerading as brevity rather than deliberately packed concision.
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?
For a four-parameter, zero-coverage, no-annotation, no-output-schema tool, this definition omits everything an agent needs: input meaning, requirements, and result shape. It is not remotely complete.
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 description coverage is 0% across four parameters (code, name, source, project), and the description says nothing about any of them. An agent cannot tell whether 'source' is a repo path, URL, or raw text, nor how 'code', 'name', and 'project' relate. The description fails to compensate for the coverage gap.
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 clear verb+resource combination ('Generate a README with AI'), so an agent knows the general outcome. However, it does not distinguish this tool from the near-identical sibling x402-readme-gen, leaving ambiguity about which of the two to call. The presence of a directly competing sibling makes the lack of differentiation a real gap.
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?
There is no when-to-use, when-not-to-use, prerequisite, or alternative guidance whatsoever. With x402-readme-gen present in the sibling list, some routing guidance was especially needed.
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.