光标模型上下文协议 (MCP) 示例

此仓库包含可用于增强光标 IDE 功能的模型上下文协议 (MCP) 服务器示例实现。

什么是模型上下文协议？

模型上下文协议 (MCP) 是一个开放协议，标准化了应用程序如何向大型语言模型 (LLMs) 提供上下文信息。它允许您创建自定义工具，这些工具可以与 AI 助手在光标中一起使用，以增强人工智能功能。

想象一下 MCP 就像 USB-C 端口对于设备和外设：

• 就像 USB-C 提供了一种标准化的方式来连接您的设备到各种外围设备一样，MCP 提供了一种标准化的方式将 AI 模型与不同的数据源和工具相连接
• 它使 AI 助手能够访问实时信息、执行专门功能，并超越其训练数据的局限

项目结构

example-mcp/
├── mcp-servers/                # 不同的 MCP 服务器实现
│   ├── task-manager/           # 任务管理器 MCP 服务器示例
│   ├── file-explorer/          # 文件浏览器 MCP 服务器示例
│   └── weather-service/        # 天气服务 MCP 服务器示例
├── README.md                   # 项目文档
└── LICENSE                     # 许可证信息

快速开始

先决条件

• Node.js (版本 >= 14)
• npm 或 yarn 包管理器
• 光标 IDE (版本 >= 2023.12)

设置 MCP 服务器

1. 克隆此仓库：

git clone https://github.com/yourusername/example-mcp.git
cd example-mcp

2. 安装依赖项：

npm install @modelcontextprotocol/server express

3. 启动 MCP 服务器：

node index.js

在光标中连接 MCP 服务器

1. 打开光标 IDE。
2. 点击右上角的齿轮图标，进入设置菜单。
3. 选择“上下文” > “模型上下文协议”。
4. 点击“添加服务器”，输入以下信息：
   • 名称：示例 MCP 服务器
   • 类型：HTTP
   • 地址：http://localhost:3000
5. 点击“保存”。

示例 MCP 服务器

任务管理器

• 名称: task-manager
• 描述: 创建、更新和删除任务。
• 参数 schema:

  {
    "type": "object",
    "properties": {
      "action": { "type": "string", "enum": ["create", "update", "delete"] },
      "task": {
        "type": "object",
        "properties": {
          "id": { "type": "integer" },
          "title": { "type": "string" },
          "description": { "type": "string" }
        }
      }
    }
  }
  

文件浏览器

• 名称: file-explorer
• 描述: 浏览文件系统并执行操作。
• 参数 schema:

  {
    "type": "object",
    "properties": {
      "action": { "type": "string", "enum": ["list", "open"] },
      "path": { "type": "string" }
    }
  }
  

天气服务

• 名称: weather-service
• 描述: 获取天气信息。
• 参数 schema:

  {
    "type": "object",
    "properties": {
      "action": { "type": "string", "enum": ["get_weather"] },
      "location": { "type": "string" }
    }
  }
  

MCP 架构

组件

• MCP 主机: 提供上下文信息的组件。
• MCP 客户端: 调用 MCP 服务的组件。
• MCP 服务器: 实现具体功能并响应请求的组件。

传输方式

Stdio

const { createServer } = require('@modelcontextprotocol/server');

createServer()
  .registerTool('task-manager', {
    name: 'Task Manager',
    description: 'Create, update and delete tasks.',
    paramsSchema: {
      type: 'object',
      properties: {
        action: { type: 'string', enum: ['create', 'update', 'delete'] },
        task: {
          type: 'object',
          properties: {
            id: { type: 'integer' },
            title: { type: 'string' },
            description: { type: 'string' }
          }
        }
      }
    }
  })
  .listen(3000, () => console.log('Server is running on port 3000'));

HTTP (SSE)

const express = require('express');
const { createServer } = require('@modelcontextprotocol/server');

const app = express();

createServer(app).registerTool('file-explorer', {
  name: 'File Explorer',
  description: 'Browse file system and perform operations.',
  paramsSchema: {
    type: 'object',
    properties: {
      action: { type: 'string', enum: ['list', 'open'] },
      path: { type: 'string' }
    }
  }
});

app.listen(3000, () => console.log('Server is running on port 3000'));

创建自己的 MCP 服务器

1. 初始化项目：

mkdir my-mcp-server && cd $_
npm init -y

2. 安装依赖：

npm install @modelcontextprotocol/server express

3. 创建主文件 index.js:

const express = require('express');
const { createServer } = require('@modelcontextprotocol/server');

const app = express();

createServer(app).registerTool('my-tool', {
  name: 'My Tool',
  description: 'Perform custom operations.',
  paramsSchema: {
    type: 'object',
    properties: {
      action: { type: 'string' },
      params: { type: 'object' }
    }
  }
});

app.listen(3000, () => console.log('Server is running on port 3000'));

4. 启动服务器：

node index.js

许可证

本项目遵循 MIT 许可证。查看 LICENSE 文件获取详细信息。

贡献者

• [Your Name]