Vscode Internal Command MCP Server

🚀 VSCode 内部命令 MCP 服务器

这是一个基于 FastMCP 框架的 VSCode 扩展，它能将 VSCode 转换为 MCP（Model Context Protocol）服务器。借助该扩展，外部客户端可通过 HTTP Streaming 和 Server-Sent Events（SSE）执行 VSCode 内部命令，为开发者提供更便捷的操作体验。

🚀 快速开始

此扩展可将 VSCode 转换为强大的 MCP 服务器，支持外部客户端通过特定协议执行 VSCode 内部命令。以下是使用前的准备步骤：

安装

1. 克隆项目

git clone https://github.com/bestk/vscode-internal-command-mcp-server
cd vscode-internal-command-mcp-server

2. 安装依赖

npm install

3. 编译项目

npm run compile

4. 在 VSCode 中安装

• 按 F5 启动扩展开发主机
• 或者打包为 .vsix 文件进行安装

配置

在 VSCode 设置中配置服务器参数：

{
    "vscode-internal-command-mcp-server.port": 8080,
    "vscode-internal-command-mcp-server.host": "localhost",
    "vscode-internal-command-mcp-server.autoStart": true,
    "vscode-internal-command-mcp-server.asyncExecution": true,
    "vscode-internal-command-mcp-server.executionDelay": 1000,
    "vscode-internal-command-mcp-server.showAsyncNotifications": false,
    "vscode-internal-command-mcp-server.allowedCommands": [
        "editor.action.formatDocument",
        "workbench.action.files.save",
        "editor.action.clipboardCopyAction"
    ]
}

配置说明

启动服务器

1. 自动启动：扩展激活时自动启动（如果 autoStart 为 true）
2. 手动启动：
   • 命令面板：VSCode Internal Command MCP Server: Start Server
   • 或点击状态栏中的 🚀 VSCode internal command MCP 按钮

服务器地址

• MCP 端点：http://localhost:8080/mcp
• 健康检查：http://localhost:8080/health

状态监控

• 状态栏显示：🚀 VSCode internal command MCP 🟢 (运行中) / 🚀 VSCode internal command MCP 🔴 (已停止)
• 命令面板：VSCode Internal Command MCP Server: Show Status 查看详细状态

✨ 主要特性

• 🌐 HTTP Streaming 支持：使用 text/event-stream 协议，支持实时通信
• 🔧 VSCode 命令执行：远程执行任意 VSCode 内部命令
• 📊 工作区信息查询：获取当前工作区状态和文件信息
• ⚡ 异步后台执行：支持异步命令执行，不阻塞用户界面
• ⏰ 可配置延时：支持设置命令执行延时
• 🛡️ 安全控制：可配置的命令白名单机制
• 📡 实时状态监控：状态栏显示服务器运行状态
• 🔗 标准 MCP 协议：完全兼容 Model Context Protocol 规范
• ⚡ 高性能：基于 FastMCP 框架，支持并发请求和会话管理
• 🩺 健康检查：内置健康检查端点

📦 安装指南

1. 克隆项目

git clone https://github.com/bestk/vscode-internal-command-mcp-server
cd vscode-internal-command-mcp-server

2. 安装依赖

npm install

3. 编译项目

npm run compile

4. 在 VSCode 中安装

• 按 F5 启动扩展开发主机
• 或者打包为 .vsix 文件进行安装

💻 使用示例

基础用法

客户端连接示例

import { StreamableHTTPClientTransport } from '@modelcontextprotocol/sdk/client/streamableHttp.js';
import { Client } from '@modelcontextprotocol/sdk/client/index.js';

const transport = new StreamableHTTPClientTransport(new URL('http://localhost:8080/mcp'), {
    requestInit: {
        headers: {
            'Content-Type': 'application/json',
            Accept: 'application/json, text/event-stream',
        },
    },
});

const client = new Client({
    name: 'vscode-mcp-client',
    version: '1.0.0',
});

// 连接并使用
await client.connect(transport);

// 调用工具
const result = await client.callTool({
    name: 'execute_vscode_command',
    arguments: {
        "command": "editor.action.formatDocument"
    },
});

console.log('Command result:', result);

使用 Cursor 配置示例

{
    "mcpServers": {
        "vscode-internal-commands": {
            "url": "http://localhost:8080/mcp",
            "transport": "http"
        }
    }
}

使用 curl 测试示例

# 健康检查
curl http://localhost:8080/health

# 列出工具
curl -X POST http://localhost:8080/mcp \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/list"
  }'

# 执行命令
curl -X POST http://localhost:8080/mcp \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 2,
    "method": "tools/call",
    "params": {
      "name": "execute_vscode_command",
      "arguments": {
        "command": "workbench.action.files.save"
      }
    }
  }'

高级用法

异步执行响应示例

{
    "success": true,
    "async": true,
    "taskId": "bg_task_1_1756952250790",
    "message": "命令 'composer.cancelComposerStep' 已提交到后台执行，将在 1000ms 后执行",
    "command": "composer.cancelComposerStep",
    "arguments": [],
    "executionDelay": 1000,
    "queueLength": 1,
    "taskStats": {
        "total": 1,
        "pending": 1,
        "running": 0,
        "completed": 0,
        "failed": 0,
        "cancelled": 0
    }
}

📚 详细文档

可用工具 (MCP Tools)

1. execute_vscode_command

执行 VSCode 内部命令 参数：

{
  "command": string;      // VSCode 命令 ID
  "arguments"?: string[]; // 命令参数（可选）
}

2. list_vscode_commands

列出所有可用的 VSCode 命令 参数：无 返回：命令列表（前 20 个，如果超过会显示省略提示）

3. get_workspace_info

获取当前工作区信息 参数：无 返回：

{
    "name": string; // 工作区名称
    "folders": Array<{
        // 工作区文件夹
        "name": string;
        "uri": string;
    }>;
    "activeEditor": string; // 当前活动编辑器文件路径
}

🔧 技术细节

核心组件

┌─────────────────────────┐
│   VSCode Extension      │
├─────────────────────────┤
│   FastMcpServer         │ ← 基于 FastMCP 框架
├─────────────────────────┤
│   ServerManager         │ ← 服务器管理和状态
├─────────────────────────┤
│   CommandExecutor       │ ← VSCode 命令执行器
├─────────────────────────┤
│ BackgroundTaskExecutor  │ ← 后台任务执行器
├─────────────────────────┤
│   TaskProvider          │ ← VS Code 任务提供者
└─────────────────────────┘

技术栈

• 框架：FastMCP - TypeScript MCP 服务器框架
• 协议：Model Context Protocol (MCP)
• 传输：HTTP Streaming with Server-Sent Events (SSE)
• 验证：Zod Schema 验证
• 平台：VSCode Extension API
• 异步执行：基于 setInterval 的后台任务队列

网络协议

• 传输类型：httpStream
• 内容类型：text/event-stream
• 支持协议：HTTP/1.1
• CORS：默认启用

异步执行机制

• 任务队列：基于 Map 数据结构的内存队列
• 执行器：使用 setInterval 定期检查待执行任务
• 状态管理：支持 pending、running、completed、failed、cancelled 状态
• 延时执行：支持配置延时，任务在指定时间后执行
• 通知系统：可选的执行完成通知

📄 许可证

本项目采用 MIT 许可证，详见 LICENSE 文件。