GitHub README 获取工具

GitHub自述MCP服务器

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

安装

1. 克隆此存储库。

2. 使用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服务器，它应该显示已连接。