convez.ai
MCP ServerIntegração & APIsIntermediário
bradford-tech

NPM Package README MCP Server

bradford-tech/npm-package-readme-mcp-server

Acessa READMEs, metadados e estatísticas de pacotes npm via MCP

Ver no GitHub
InicialPluginScore · de 0 a 100

Um servidor MCP que expõe dados do registro npm — READMEs de pacotes, metadados e busca — para clientes IA compatíveis. Recupera informações do npm registry com fallback para GitHub API e inclui cache em memória para otimizar requisições.

Instalação

$npx convez-ai bradford-tech/npm-package-readme-mcp-server

1 comando no terminal: detecta o formato do repositório (marketplace ou plugin avulso) e instala via Claude Code. Requer Node 18+ e o Claude Code instalado.

Métricas

Estrelas
0
Forks
0
Acompanhando
0
Saúde
50%
Último commit
há 1 mês
Versão
npm-package-readme-mcp-server-v0.2.0
Issues abertas
1
Contribuidores
3

Casos de uso

  • Buscar documentação de pacotes npm programaticamente
  • Extrair exemplos de uso de READMEs durante desenvolvimento
  • Pesquisar pacotes por critérios de qualidade e popularidade
  • Obter dependências e metadados de projetos para análise
  • Integrar dados npm em agentes IA e workflows automatizados

Veredito

MCP server bem construído que democratiza o acesso a dados npm via Claude e clientes IA. Implementação madura (fork mantido), com caching inteligente e tratamento sensato de fallbacks GitHub — útil para quem trabalha com automação ao redor do ecossistema Node.js.

README

A tradução para o português deste README ainda está na fila.

@bradford-tech/npm-package-readme-mcp-server

An MCP server that exposes npm registry data — package READMEs, metadata, and search — to MCP-compatible AI clients.

This is a maintained fork of naoto24kawa/npm-package-readme-mcp-server, republished under the @bradford-tech scope after the original was removed from GitHub and npm. No functional changes from the upstream 0.1.4 release.

Install

npm install -g @bradford-tech/npm-package-readme-mcp-server

Also works with pnpm add -g, yarn global add, or via npx (no install needed).

Configure your MCP client

Add the server to your client's MCP configuration:

{
  "mcpServers": {
    "npm-package-readme": {
      "command": "npm-package-readme-mcp-server"
    }
  }
}

Or run on demand with npx:

{
  "mcpServers": {
    "npm-package-readme": {
      "command": "npx",
      "args": ["-y", "@bradford-tech/npm-package-readme-mcp-server"]
    }
  }
}

Tools

The server exposes three tools to the connected client.

get_readme_from_npm

Fetches a package's README and extracts usage examples. Reads from the npm registry first, falls back to the linked GitHub repository.

ParameterTypeDefaultDescription
package_namestring—The npm package name (required).
versionstring"latest"Specific version or dist-tag.
include_examplesbooleantrueParse and return usage examples extracted from the README.

Example call:

{ "package_name": "react", "version": "18.2.0" }

get_package_info_from_npm

Returns package metadata and download statistics for the latest version.

ParameterTypeDefaultDescription
package_namestring—The npm package name (required).
include_dependenciesbooleantrueInclude runtime dependencies.
include_dev_dependenciesbooleanfalseInclude dev dependencies.

Example call:

{ "package_name": "express", "include_dependencies": true }

search_packages_from_npm

Searches the npm registry.

ParameterTypeDefaultDescription
querystring—Search text (required).
limitnumber20Max results, 1–250.
qualitynumber—Minimum quality score, 0–1.
popularitynumber—Minimum popularity score, 0–1.

Example call:

{ "query": "testing framework", "limit": 10 }

How package data is fetched

  • Package metadata and READMEs come from registry.npmjs.org.
  • If the registry response has no README, the server resolves the repository field and fetches the README from the GitHub API.
  • Download statistics come from api.npmjs.org/downloads.
  • Responses are cached in memory (default TTL: 1 hour; search results: 10 minutes).

GitHub anonymous API requests are rate-limited to 60/hour. The server logs a warning when no token is available but still works for low-volume use.

Configuration

All settings are optional environment variables, passed via your MCP client's env field (or your shell, when launching directly).

VariableDefaultDescription
CACHE_TTL3600Default cache TTL in seconds for get_readme_from_npm and get_package_info_from_npm. Search results have a fixed 10-minute TTL.
REQUEST_TIMEOUT30000Per-request timeout in milliseconds, applied to npm registry and GitHub API calls.
GITHUB_TOKEN—GitHub personal access token. Raises the GitHub API rate limit from 60/hour to 5000/hour.
LOG_LEVELINFOOne of ERROR, WARN, INFO, DEBUG (case-insensitive). Invalid values silently fall back to INFO. Logs are written to stderr.

Example, with a GitHub token:

{
  "mcpServers": {
    "npm-package-readme": {
      "command": "npm-package-readme-mcp-server",
      "env": {
        "GITHUB_TOKEN": "ghp_..."
      }
    }
  }
}

Requirements

  • Node.js >= 20

Contributing

Issues and pull requests welcome at bradford-tech/npm-package-readme-mcp-server. See CONTRIBUTING.md for the developer setup.

License

MIT. See LICENSE.

Ver o original no GitHub

Bom para

Relacionados