{"_id":"@aki77/package-readme-mcp","_rev":"3-d905c966e0ac31fc0752b80382e291a5","name":"@aki77/package-readme-mcp","dist-tags":{"latest":"0.2.1"},"versions":{"0.1.0":{"name":"@aki77/package-readme-mcp","version":"0.1.0","keywords":["mcp","npm","gem","readme","model-context-protocol"],"author":"","license":"ISC","_id":"@aki77/package-readme-mcp@0.1.0","maintainers":[{"name":"aki77","email":"lala.akira+npm@gmail.com"}],"bin":{"package-readme-mcp":"dist/index.js"},"dist":{"shasum":"1438904da5cd97e33c0519abc828293b60360a6a","tarball":"https://registry.npmjs.org/@aki77/package-readme-mcp/-/package-readme-mcp-0.1.0.tgz","fileCount":56,"integrity":"sha512-W70rpVYwmpKw8Dnq4ETXYmoKbE/JIx9M6veIqSw171AQp9yC3umaa4+rC2yeKwiLjASP8msyYCotEsBap5+3Iw==","signatures":[{"sig":"MEUCIQCsMKTm5N0n38Lv2HHCtjrHXD5W1ILkzgDI7D0JTXDrdgIgV4dbxhoLnLzwEXfuzqGsF/PecCAAW6vPYMBc86oNtO8=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":83213},"main":"dist/index.js","type":"module","types":"./dist/index.d.ts","gitHead":"acbf97bd997cf3a19284e11d6c04164366741fbb","scripts":{"dev":"tsc --watch","lint":"biome lint .","test":"vitest run","build":"tsc","check":"biome check --write .","start":"node dist/index.js","format":"biome format --write .","test:ui":"vitest --ui","typecheck":"tsc --noEmit","test:coverage":"vitest --coverage","prepublishOnly":"pnpm run build"},"_npmUser":{"name":"aki77","actor":{"name":"aki77","type":"user","email":"lala.akira+npm@gmail.com"},"email":"lala.akira+npm@gmail.com"},"_npmVersion":"9.6.6","description":"MCP server for fetching README files from npm packages and Ruby gems","directories":{},"_nodeVersion":"22.14.0","dependencies":{"zod":"^3.25.67","@modelcontextprotocol/sdk":"^1.13.2"},"_hasShrinkwrap":false,"packageManager":"pnpm@9.15.9+sha512.68046141893c66fad01c079231128e9afb89ef87e2691d69e4d40eee228988295fd4682181bae55b58418c3a253bde65a505ec7c5f9403ece5cc3cd37dcf2531","devDependencies":{"vitest":"^3.2.4","typescript":"^5.8.3","@types/node":"^24.0.7","@biomejs/biome":"^2.0.6"},"_npmOperationalInternal":{"tmp":"tmp/package-readme-mcp_0.1.0_1751197644024_0.3561772511195218","host":"s3://npm-registry-packages-npm-production"}},"0.2.0":{"name":"@aki77/package-readme-mcp","version":"0.2.0","keywords":["mcp","npm","gem","readme","model-context-protocol"],"author":"","license":"ISC","_id":"@aki77/package-readme-mcp@0.2.0","maintainers":[{"name":"aki77","email":"lala.akira+npm@gmail.com"}],"bin":{"package-readme-mcp":"dist/index.js"},"dist":{"shasum":"3b2382221d2c2ad30a7a2ea2cfbd344602b20bcb","tarball":"https://registry.npmjs.org/@aki77/package-readme-mcp/-/package-readme-mcp-0.2.0.tgz","fileCount":78,"integrity":"sha512-acsLwtid1NB2OE6fTgxe164tMMoQJvUwQAHuZm131ppLtI2lCRJhbBCjLgvURNdrPWni2aWyttPj6DnyyGDAEg==","signatures":[{"sig":"MEYCIQD1SzKPAdiZmfyGoOVAFdECZ5b5aQ9VSBc+drbxMSxuBQIhAM17LAsUxPWMDavmWb3B1VrYq7jjZiLim6YX3A0iEJ6H","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":125614},"main":"dist/index.js","type":"module","types":"./dist/index.d.ts","gitHead":"41d000e3f5414bae739e4e68e8e9d39fdb0b0e32","scripts":{"dev":"tsc --watch","lint":"biome lint .","test":"vitest run","build":"tsc","check":"biome check --write .","start":"node dist/index.js","format":"biome format --write .","test:ui":"vitest --ui","typecheck":"tsc --noEmit","test:coverage":"vitest --coverage","prepublishOnly":"pnpm run build"},"_npmUser":{"name":"aki77","actor":{"name":"aki77","type":"user","email":"lala.akira+npm@gmail.com"},"email":"lala.akira+npm@gmail.com"},"_npmVersion":"9.6.6","description":"MCP server for fetching README files and GitHub repository information from npm packages and Ruby gems","directories":{},"_nodeVersion":"22.14.0","dependencies":{"zod":"^3.25.67","@modelcontextprotocol/sdk":"^1.13.2"},"_hasShrinkwrap":false,"packageManager":"pnpm@9.15.9+sha512.68046141893c66fad01c079231128e9afb89ef87e2691d69e4d40eee228988295fd4682181bae55b58418c3a253bde65a505ec7c5f9403ece5cc3cd37dcf2531","devDependencies":{"vitest":"^3.2.4","typescript":"^5.8.3","@types/node":"^24.0.7","@biomejs/biome":"^2.0.6"},"_npmOperationalInternal":{"tmp":"tmp/package-readme-mcp_0.2.0_1751805933525_0.9332706672673734","host":"s3://npm-registry-packages-npm-production"}},"0.2.1":{"name":"@aki77/package-readme-mcp","version":"0.2.1","description":"MCP server for fetching README files and GitHub repository information from npm packages and Ruby gems","type":"module","main":"dist/index.js","bin":{"package-readme-mcp":"dist/index.js"},"scripts":{"build":"tsc","dev":"tsc --watch","start":"node dist/index.js","test":"vitest run","test:coverage":"vitest --coverage","test:ui":"vitest --ui","lint":"biome lint .","format":"biome format --write .","check":"biome check --write .","typecheck":"tsc --noEmit","prepublishOnly":"pnpm run build"},"keywords":["mcp","npm","gem","readme","model-context-protocol"],"author":"","license":"ISC","packageManager":"pnpm@9.15.9+sha512.68046141893c66fad01c079231128e9afb89ef87e2691d69e4d40eee228988295fd4682181bae55b58418c3a253bde65a505ec7c5f9403ece5cc3cd37dcf2531","dependencies":{"@modelcontextprotocol/sdk":"^1.13.2","zod":"^3.25.67"},"devDependencies":{"@biomejs/biome":"^2.0.6","@types/node":"^24.0.7","typescript":"^5.8.3","vitest":"^3.2.4"},"types":"./dist/index.d.ts","gitHead":"cea38d079947f985c9ed8753ec0acd7c86ea85fc","_id":"@aki77/package-readme-mcp@0.2.1","_nodeVersion":"22.14.0","_npmVersion":"9.6.6","dist":{"integrity":"sha512-h4OsxP++eEjyJZxRfnXEBhLa7WJ8AtR7Cci8yKHHNuMAs8zu4LiqrLhnoFC2R6cUbbTtx7M1F1++9a2IC8JdrA==","shasum":"d5c3189258b804024304fa27eb4f2f86dc7a8fea","tarball":"https://registry.npmjs.org/@aki77/package-readme-mcp/-/package-readme-mcp-0.2.1.tgz","fileCount":89,"unpackedSize":129362,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDbnawXkci0nUBFXZlVdOOEQQLBMScA9S/pVLUs3A5g6QIhALJELTBKWIjZXAWWsNxgNMloZO6w+cR/3R+K1NgpHNzo"}]},"_npmUser":{"name":"aki77","email":"lala.akira+npm@gmail.com","actor":{"name":"aki77","email":"lala.akira+npm@gmail.com","type":"user"}},"directories":{},"maintainers":[{"name":"aki77","email":"lala.akira+npm@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/package-readme-mcp_0.2.1_1751839789851_0.43399335623366375"},"_hasShrinkwrap":false}},"time":{"created":"2025-06-29T11:47:23.955Z","modified":"2025-07-06T22:09:50.204Z","0.1.0":"2025-06-29T11:47:24.272Z","0.2.0":"2025-07-06T12:45:33.737Z","0.2.1":"2025-07-06T22:09:50.029Z"},"license":"ISC","keywords":["mcp","npm","gem","readme","model-context-protocol"],"description":"MCP server for fetching README files and GitHub repository information from npm packages and Ruby gems","maintainers":[{"name":"aki77","email":"lala.akira+npm@gmail.com"}],"readme":"# package-readme-mcp\n\nAn MCP (Model Context Protocol) server for retrieving package README files and GitHub repository information. Supports both NPM packages and Ruby Gems.\n\n## Overview\n\nThis MCP server allows you to fetch README files and GitHub repository names from npm or gem packages installed in your project, making it easy to access documentation such as usage instructions, API references, and code examples. When combined with [deepwiki MCP](https://mcp.deepwiki.com/), you can obtain even more detailed information from the GitHub repositories.\n\n## Features\n\n- **NPM Packages**: Retrieve the README and GitHub repository name of installed NPM packages in your project\n- **Ruby Gems**: Retrieve the README and GitHub repository name of installed Ruby gems in your project\n- **GitHub Integration**: Get repository names in `owner/repo` format for further analysis with tools like [deepwiki MCP](https://mcp.deepwiki.com/)\n\n## Usage\n\n### As an MCP Client\n\nThis server can be used from any client that supports the MCP protocol (such as Claude Code, VS Code, etc.).\n\n#### Claude Code\n\n```shell\nclaude mcp add -s user package-readme -- npx -y @aki77/package-readme-mcp\n```\n\n#### VSCode Configuration\n\nAdd the following to your `.vscode/mcp.json`:\n\n```json\n{\n  \"servers\": {\n    \"package-readme\": {\n      \"type\": \"stdio\",\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"@aki77/package-readme-mcp\"]\n    }\n  }\n}\n```\n\n## Available Tools\n\n### get_npm_readme\n\nRetrieves the README for an NPM package.\n\n**Parameters:**\n- `name` (required): NPM package name (supports scoped packages like `@scope/package`)\n\n**Examples:**\n```\nget_npm_readme\nname: react\n```\n\n```\nget_npm_readme\nname: @types/react\n```\n\n### get_gem_readme\n\nRetrieves the README for a Ruby Gem.\n\n**Parameters:**\n- `name` (required): Gem package name\n\n**Example:**\n```\nget_gem_readme\nname: rails\n```\n\n### get_npm_github_repository\n\nRetrieves the GitHub repository name for an NPM package in `owner/repo` format.\n\n**Parameters:**\n- `name` (required): NPM package name (supports scoped packages like `@scope/package`)\n\n**Examples:**\n```\nget_npm_github_repository\nname: react\n```\nReturns: `facebook/react`\n\n```\nget_npm_github_repository\nname: @types/react\n```\nReturns: `DefinitelyTyped/DefinitelyTyped`\n\n### get_gem_github_repository\n\nRetrieves the GitHub repository name for a Ruby Gem in `owner/repo` format.\n\n**Parameters:**\n- `name` (required): Gem package name\n\n**Example:**\n```\nget_gem_github_repository\nname: rails\n```\nReturns: `rails/rails`\n","readmeFilename":"README.md"}