第 1 卷

IDE插件CLIWorkBuddyWorkBuddy 小程序WorkBuddy 移动端企业版

Menu快速导航

MCP (Model Context Protocol)使用文档

概述

MCP (Model Context Protocol) 是一个开放标准，允许 CodeBuddy 与外部工具和数据源进行集成。通过 MCP，您可以扩展 CodeBuddy 的功能，连接到各种外部服务、数据库、API 等。

核心概念

MCP服务器

MCP 服务器是提供工具、资源和提示的独立进程，CodeBuddy 通过不同的传输协议与这些服务器通信。

MCP Prompts 集成

MCP 服务器可以提供 Prompts（提示模板）,这些 Prompts会自动转换为 CodeBuddy 的斜杠命令。当 MCP 服务器连接后：

服务器提供的 Prompts会自动注册为斜杠命令

命令名称格式为： /服务器名:prompt名称

支持动态参数，通过交互式界面收集用户输入

命令执行时会调用 MCP 服务器的 prompts/get 接口获取完整内容

支持实时监听配置变更，自动更新可用命令列表

传输类型

STDIO：通过标准输入输出与本地进程通信

SSE：通过 Server-Sent Events与远程服务通信

HTTP：通过 HTTP 流式传输与远程服务通信

配置作用域

user：全局用户配置，应用于所有项目

local：本地配置，仅应用于当前会话或工作区

对于同名服务（即在多个作用域有同名配置），生效的优先级为： local > project > user

安全审批机制

项目作用域的 MCP 服务器在首次连接时需要用户审批，以确保安全性。系统会显示服务器详细信息，用户可以选择批准或拒绝连接。

非交互模式（-p/--print）下的审批

在非交互模式（如使用 -p/--print 参数)下,由于无法通过 UI 进行审批,需要通过 --settings

参数预先配置允许的 MCP 服务器：

bash

# 方式 1：允许所有项目 MCP 服务器 codebuddy --settings '{"enableAllProjectMcpServers": true}' -p "your prompt"

# 方式 2：允许特定的 MCP 服务器 codebuddy --settings '{"enabledMcpjsonServers": ["server-name-1", "server-name-

工具权限管理

MCP 工具支持完整的权限管理系统，可以精确控制哪些工具可以被使用：

权限规则类型

权限系统支持三种规则类型（按优先级排序）：

1.拒绝规则（deny) -阻止使用指定工具（最高优先级）

2.询问规则（ask) -使用工具前需要用户确认（覆盖允许规则）

3.允许规则（allow) -允许工具使用而无需手动批准

MCP权限规则格式

重要：MCP 权限不支持通配符（*)

服务器级权限

mcp__服务器名

匹配指定服务器提供的任何工具

服务器名是在 CodeBuddy 中配置的名称

工具级权限

mcp__服务器名__工具名

匹配指定服务器的特定工具

配置示例

批准服务器的所有工具

json

{ "permissions": { "allow": [ "mcp__github"

] } }

仅批准特定工具

json

{ "permissions": { "allow": [ "mcp__github__get_issue", "mcp__github__list_issues"

] } }

拒绝特定工具

json

{ "permissions": { "deny": [ "mcp__dangerous_server__delete_file"

] } }

配置文件

配置文件位置

配置文件使用优先级机制，系统会按优先级顺序查找第一个存在的文件进行读取。写入时，如果文