Token导航 LogoToken导航TokenDH.com
GitHub Readme MCP logo
开发工具stdio官方级别未说明来源级核验

GitHub Readme MCP

MCP Server

@modelcontextprotocol/inspector

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

工具数

1

提示词数

0

GitHub Stars

0

资源数

0
GitHub工具本地服务器TypeScript开发工具

安装说明

本站只整理中文说明和来源信息,不托管安装包,也不代用户安装。

作者 / 组织

Raghavvram

提供方

Raghavvram

最后核验

2026/5/17 20:22

运行时

Node.js

快速接入

先看主来源和安装命令,再打开仓库或文档;下面只保留这个条目的关键接入事实。

命令预览

npx @modelcontextprotocol/inspector node build/index.js

详细介绍

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服务器,它应该显示已连接。

目录标签

目录标签

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

接入字段

传输方式(transport,传输协议)

stdio

鉴权方式(authType,认证方式)

none

运行时(runtime,运行环境)

Node.js

来源包(packageName,安装包名)

@modelcontextprotocol/inspector

工具数量(toolCount,工具数)

1

资源数量(resourceCount,资源数)

0

提示词数量(promptCount,提示词数)

0

权限和风险

stdionone部署方式未说明

接入前请确认传输方式、认证方式和部署位置,并根据实际工具能力限制访问范围。

安装前确认

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

来源信息

继续浏览同类 MCP