使用说明

项目简介

Peacock MCP Server 是一个基于 Model Context Protocol (MCP) 实现的服务器，专门为 Peacock for VS Code 插件设计。它通过 MCP 协议向 LLM 客户端提供工具，允许用户通过自然语言查询 Peacock 插件的官方文档，从而更方便地了解和使用 Peacock 插件的各项功能。该项目旨在演示 MCP 服务器在实际应用中的价值，展示如何通过标准化的方式为 LLM 应用提供上下文信息和功能扩展。

主要功能点

文档查询工具: 提供 'fetch_peacock_docs' 工具，用户可以通过自然语言提问，服务器将从 Peacock 插件的官方文档中检索相关信息并返回答案。
MCP 标准实现: 遵循 MCP 协议规范，使用 JSON-RPC 通信，并提供工具注册和执行功能。
易于部署和配置: 可以通过 Smithery 自动安装，也可以手动克隆仓库并本地运行，支持多种 MCP 客户端连接方式，例如 MCP Inspector 和 GitHub Copilot。

安装步骤

安装 Peacock for VS Code 插件: 如果尚未安装，请先在 VS Code 扩展商店中搜索 "Peacock" 并安装。

克隆仓库: 将 Peacock MCP Server 仓库克隆到本地：

git clone https://github.com/johnpapa/peacock-mcp

安装依赖并构建: 进入仓库目录，运行以下命令安装依赖并构建项目：
```
npm install
npm run build
```

服务器配置

MCP 服务器需要配置在 MCP 客户端中才能使用。以下是在 VS Code 中配置 Peacock MCP Server 的方法，适用于支持 MCP 的客户端，例如 GitHub Copilot Agent 模式。

配置信息 (JSON 格式):

{
  "servers": {
    "peacock-mcp": {  // 服务器名称，可以自定义
      "command": "npx", // 启动服务器的命令，这里使用 npx 运行 npm 包
      "args": [
        "-y",
        "@johnpapa/peacock-mcp" //  npm 包名称，npx 会自动下载并执行
      ],
      "env": {} // 环境变量，当前配置为空
    }
  }
}

配置方法 (选择其一):

方法一：针对特定仓库配置 在你的 VS Code 项目仓库根目录下创建 '.vscode/mcp.json' 文件，并将上述 JSON 配置粘贴到文件中。

方法二：全局用户配置 打开 VS Code 设置 (File -> Preferences -> Settings 或 Code -> Settings -> Settings)，点击右上角的 "Open Settings (JSON)" 图标，打开 'settings.json' 文件，将以下 JSON 配置添加到文件中：

"mcp": {
  "servers": {
    "peacock-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@johnpapa/peacock-mcp"
      ],
      "env": {}
    }
  }
},
"chat.mcp.discovery.enabled": true, // 启用 MCP 服务器自动发现

注意: 'chat.mcp.discovery.enabled: true' 用于启用 MCP 服务器自动发现，确保客户端能够找到并连接到 Peacock MCP Server。

基本使用方法

启动 MCP 客户端: 启动支持 MCP 协议的客户端，例如 VS Code Insider 版本的 GitHub Copilot Agent 模式。
刷新服务器列表: 在 Copilot Agent 聊天输入框中，点击刷新按钮 (通常是一个循环箭头图标) 以刷新服务器列表。
查看可用工具: 点击聊天输入框中的 "🛠️" 工具按钮，查看所有可用的工具，包括来自 Peacock MCP Server 的 'fetch_peacock_docs' 工具。
使用工具提问: 在 Copilot Agent 聊天输入框中，输入自然语言问题，例如：
```
How do I set my VS Code accent colors using Peacock?
```
Copilot Agent 将自动识别并调用 'fetch_peacock_docs' 工具，从 Peacock 文档中检索相关信息并返回答案。

Peacock MCP Server