Get npm Package README
npm_package_readmeRetrieve the README markdown content of any npm package, including installation instructions and usage examples.
Instructions
Get the README content of an npm package.
Returns the package's README markdown content, which typically includes installation instructions, usage examples, API documentation, and configuration options.
Args:
package_name (string): The npm package name
Returns: README content in markdown format. Large READMEs are truncated to 25000 characters with a notice.
Examples:
"zod" -> Zod README with schema validation examples
"express" -> Express README with routing examples
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| package_name | Yes | npm package name |