Fetch the README content of any npm package by name, giving you direct access to documentation and usage instructions from the npm registry.
Get the README content of a package.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Package name |
Changes observed during successful MCP inspections.
v0.12.2Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, covering safety behavior. The description adds no extra behavioral context, such as return format, error handling, or pagination, but it does not contradict annotations. This is acceptable but not contributive.
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?
The description is a single, short sentence that conveys the essential purpose without any filler. It is front-loaded and every word earns its place.
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 simple tool with one well-documented parameter, rich annotations, and no output schema, the description is sufficient. It could be improved by specifying the return format or handling of missing READMEs, but these are not essential for basic tool selection.
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?
The schema provides 100% coverage with the parameter 'name' described as 'Package name'. The description only repeats this by saying 'of a package', adding no extra semantic value beyond the schema, hence the baseline score of 3.
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 clearly states the tool retrieves README content for a package, using a specific verb and resource. However, it does not explicitly differentiate from sibling tools like npm_package, which may also provide README in package metadata, so it stops short of full distinction.
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?
The description provides no guidance on when to use this tool versus alternatives such as npm_package or npm_search. It does not mention exclusions, prerequisites, or context, leaving the agent without direction for tool selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.