MCP Server VS Code Extension 使用说明

项目简介

本项目是一个 VS Code 扩展，它内嵌了一个实现了 Model Context Protocol (MCP) 协议的服务器。该服务器提供了一个简单的 Echo 工具，并通过 Server-Sent Events (SSE) 协议与 MCP 客户端通信。此项目主要用于演示和测试 MCP 服务器的基本功能。

主要功能点

MCP 服务器实现: 实现了基础的 MCP 服务器功能，能够接收和处理 MCP 客户端的请求。
Echo 工具: 提供了一个简单的 'echo' 工具，客户端可以调用此工具并发送消息，服务器会返回包含该消息的响应。
SSE 通信: 使用 Server-Sent Events (SSE) 作为通信协议，允许客户端与服务器建立持久连接并接收服务器推送的消息。
VS Code 扩展: 以 VS Code 扩展的形式运行，方便开发者在 VS Code 环境中进行 MCP 服务器的测试和开发。

安装步骤

安装依赖: 打开终端，导航到扩展项目根目录（包含 'package.json' 的目录），运行以下命令安装项目依赖：
```
npm install
```
构建扩展: 运行以下命令构建 VS Code 扩展：
```
npm run build
```
安装 VS Code 扩展: 在 VS Code 中，点击左侧活动栏的扩展图标 (方块图标)，在扩展面板的右上角点击 "..." 菜单，选择 "从 VSIX 安装..."，然后选择项目根目录下生成的 '.vsix' 文件（通常在项目根目录下）。

服务器配置

MCP 客户端需要配置以下信息以连接到此 MCP 服务器。由于此 MCP 服务器以 VS Code 扩展形式运行，并在 VS Code 启动时自动启动，因此配置较为简单。

{
    "serverName": "vscode-mcp-server",
    "command": "vscode",
    "args": [],
    "transport": "sse",
    "sseUri": "http://localhost:6102/sse"
}

配置参数说明:

'serverName': 服务器名称，这里设置为 "vscode-mcp-server"。
'command': 启动服务器的命令。由于此服务器作为 VS Code 扩展运行，因此这里使用 "vscode" 表示依赖于 VS Code 运行环境。实际情况下，扩展会在 VS Code 启动时自动激活并启动 MCP 服务器，无需额外命令。
'args': 启动参数，这里为空数组，因为此服务器不需要额外的命令行参数。
'transport': 使用的传输协议，这里为 "sse" (Server-Sent Events)。
'sseUri': SSE 连接的 URI，客户端需要连接到 'http://localhost:6102/sse' 这个地址与服务器建立 SSE 连接。

基本使用方法

启动 VS Code: 安装并启用此 VS Code 扩展后，启动 VS Code 编辑器。MCP 服务器会在 VS Code 启动时自动运行。
连接 MCP 客户端: 配置 MCP 客户端连接到 'http://localhost:6102/sse' 这个 SSE URI。

调用 Echo 工具: 使用 MCP 客户端向服务器发送 JSON-RPC 请求，调用 'echo' 工具。例如，可以发送如下请求（JSON-RPC over SSE 的具体请求格式请参考 MCP 协议文档）：

{
    "jsonrpc": "2.0",
    "method": "call",
    "params": {
        "tool": "echo",
        "arguments": {
            "message": "Hello from MCP Client!"
        }
    },
    "id": 1
}

接收响应: 服务器会通过 SSE 连接返回 JSON-RPC 响应，其中包含 'echo' 工具的执行结果，例如：

{
    "jsonrpc": "2.0",
    "result": {
        "content": [
            {
                "type": "text",
                "text": "Tool echo: Hello from MCP Client!"
            }
        ]
    },
    "id": 1
}

这样，你就成功运行并使用了这个简单的 MCP 服务器扩展。

注意: 此服务器仅为演示和测试目的，功能较为基础。在实际应用中，可能需要更完善的资源管理、工具注册和 Prompt 模板等功能。

关键词