Token导航 LogoToken导航

MCP Server · 开发工具

GitHub Readme MCP

一个本地运行的 MCP 服务器,用于获取并查看任何公共 GitHub 仓库的 README.md 文件。

stdio官方级别未说明来源级核验工具 1@modelcontextprotocol/inspector
GitHub工具本地服务器TypeScript开发工具

快速开始

作者 / 组织
Raghavvram
提供方
Raghavvram
运行时
Node.js

工具数量

1

来源目录标注

资源数量

0

来源目录标注

提示词数量

0

来源目录标注

GitHub Star

0

仓库热度

收录来源

1 个

MCP World

选型结论

GitHub Readme MCP 属于开发工具类 MCP Server,公开资料标注 1 个工具,通过stdio 本地进程接入,客户端适配情况以官方文档为准,有可以直接复制的安装命令;接入前先确认权限范围。

分类

开发工具

传输方式

stdio

认证方式

无需认证

部署方式

公开资料未说明

安装与配置

安装命令

npx @modelcontextprotocol/inspector node build/index.js

公开命令不是通用的启动方式,拼不出可靠配置示例;请在客户端 MCP 配置里按官方文档填写 command 和 args。

上手步骤

  1. 1

    准备运行环境

    stdio 服务在本地起进程,需要先装好 Node.js,再按安装命令拉取依赖。

  2. 2

    安装服务

    复制下面的安装命令执行;命令里带占位符的位置换成自己的密钥或路径。

  3. 3

    写入客户端配置

    在客户端的 MCP 配置里填启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4

    验证是否可用

    连接成功后客户端会列出 1 个工具,随便调一个只读工具确认能返回结果。

接入前确认

不要直接授予不必要的文件、网络或账号权限;先核对安装命令和配置内容。

详细介绍

GitHub自述MCP服务器

此项目提供了一个本地模型上下文协议(MCP)服务器,允许您获取和查看任何公共GitHub存储库的README.md文件。

安装

  1. 克隆此存储库。
  1. 使用pnpm安装依赖项:
   pnpm install

构建服务器

要构建服务器,请运行以下命令:

pnpm build

这将编译TypeScript代码并在 build 目录。

运行服务器

服务器可以作为命令行工具运行。构建项目后,您可以使用以下命令运行服务器:

./build/index.js

服务器将启动并监听标准输入/输出上的请求。

用法

此服务器提供了一个工具: get_github_readme.

get_github_readme

此工具允许您获取公共GitHub存储库的README.md文件。

输入:

  • repoName (string):GitHub存储库的名称,格式为 owner/repo.

输出:

  • README.md文件的内容以字符串形式显示。

例子:

要获取的README.md文件 gemini-cli/gemini-cli 存储库,您将向服务器发送以下请求:

{
  "tool_code": "get_github_readme",
  "parameters": {
    "repoName": "gemini-cli/gemini-cli"
  }
}

服务器将以README.md文件的内容进行响应。

使用节点mcp检查器

npx @modelcontextprotocol/inspector node build/index.js

运行构建后,在项目目录中运行此命令。

在MCP检查器中,单击连接,然后单击列出工具。

它将显示 get_github_readme 点击它

在右侧窗口中输入autho/repo名称,例如。 gemini-cli/gemini-cli

点击运行,它将获取并显示自述文件。

将MCP添加到gemini cli

导航到工作区特定目录或用户目录中的.ggemini文件夹

将以下代码添加到settings.json文件中

  "mcpServers": {
    "github-readme": {
      "command": "node",
      "args": [
        "/ASBOLUTE/PATH/TO/THE/FILE/index.js"
      ]
    }
  }

现在打开gemini并检查mcp服务器,它应该显示已连接。

工具与能力

工具数量

1

资源数量

0

提示词数量

0

能力标签

GitHub工具TypeScript本地部署README解析本地服务器开发辅助

数量来自来源目录的标注,具体工具清单以官方文档为准。

典型使用场景

让助手直接读代码

把仓库、提交记录和 issue 交给模型检索,补全和重构时不用来回复制文件。

在对话里跑命令

触发构建、测试和脚本,执行结果直接回到上下文,省去切终端。

接进开发流程

把 PR、CI 状态和代码审查接进助手,减少在几个工具之间跳。

选择建议

值得选的地方

  • 只提供 1 个工具,职责集中,接入后不容易误操作。
  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。
  • 公开说明写得比较完整,接入前能看清能力边界。

先想清楚的地方

  • stdio 方式要求本地装好 Node.js,换机器要重新装一遍。
  • 公开摘要偏短,具体能力和限制要回到仓库确认。
  • 第三方目录整理,版本更新和行为细节以官方仓库为准。

更适合

  • 需要在开发工具场景里让模型直接调用外部能力的人。
  • 想先快速试一下、能接受在本地跑服务的人。

不太适合

  • 完全不想在本地装环境的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

5 个同类
MCP Server工具数传输方式安装命令收录来源最后核验
GitHub Readme MCP

MCP World · 本页

1stdio有1 个2026-05-17
Git 838e2ec1

MCP World

12stdio有2 个2026-05-17
Markitdown MCP 2c653a5f

MCP World

1stdio有1 个2026-05-17
Context7 MCP C671e75a

MCP World

0stdio有1 个2026-05-17
Context7 831acf40

MCP World

0stdio有1 个2026-05-17

按同分类和工具数量挑出最接近的几条,字段以各自详情页为准。

常见问题

5 条

GitHub Readme MCP 怎么安装?

公开资料给出的安装命令是 npx @modelcontextprotocol/inspector node build/index.js,运行环境为 Node.js。装完后按客户端要求写进 MCP 配置,重启客户端生效。

GitHub Readme MCP 怎么在 Claude Desktop、Cursor 里配置?

它是stdio 本地进程,客户端配置里要写启动命令和参数,运行环境是 Node.js;保存后完全退出客户端再打开,配置才会生效。

GitHub Readme MCP 收费吗?

本站只整理公开资料,不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

GitHub Readme MCP 需要 API Key 吗?

公开资料标注为无需认证,装好就能连;如果实际调用时报鉴权错误,按官方文档补上凭据。

GitHub Readme MCP 支持哪些客户端?

公开资料没有标注具体客户端;能配置本地 MCP 命令的客户端都能接,配置方式参照官方文档。

来源信息

继续浏览同类 MCP