补全

ℹ️
协议版本: 草案

模型上下文协议(MCP)为服务器提供了一种标准化的方式,为提示和资源 URI 提供参数自动补全建议。这使得用户在输入参数值时能够获得上下文建议,从而实现类似 IDE 的丰富体验。

用户交互模型

MCP 中的补全设计用于支持类似 IDE 代码补全的交互式用户体验。

例如,应用程序可能在用户输入时以下拉菜单或弹出窗口的形式显示补全建议,并能够从可用选项中进行过滤和选择。

然而,实现可以通过任何适合其需求的界面模式公开补全——协议本身不强制任何特定的用户交互模型。

协议消息

请求补全

要获取补全建议,客户端发送 completion/complete 请求,通过引用类型指定正在补全的内容:

请求:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "completion/complete",
  "params": {
    "ref": {
      "type": "ref/prompt",
      "name": "code_review"
    },
    "argument": {
      "name": "language",
      "value": "py"
    }
  }
}

响应:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "completion": {
      "values": ["python", "pytorch", "pyside"],
      "total": 10,
      "hasMore": true
    }
  }
}

引用类型

协议支持两种类型的补全引用:

类型描述示例
ref/prompt按名称引用提示{"type": "ref/prompt", "name": "code_review"}
ref/resource引用资源 URI{"type": "ref/resource", "uri": "file:///{path}"}

补全结果

服务器返回按相关性排序的补全值数组,包含:

  • 每个响应最多 100 个项目
  • 可用匹配的可选总数
  • 表示是否存在额外结果的布尔值

消息流

sequenceDiagram
    participant Client as 客户端
    participant Server as 服务器

    Note over Client: 用户输入参数
    Client->>Server: completion/complete
    Server-->>Client: 补全建议

    Note over Client: 用户继续输入
    Client->>Server: completion/complete
    Server-->>Client: 细化建议

数据类型

CompleteRequest

  • refPromptReferenceResourceReference
  • argument:包含以下内容的对象:
    • name:参数名称
    • value:当前值

CompleteResult

  • completion:包含以下内容的对象:
    • values:建议数组(最多 100 个)
    • total:可选的匹配总数
    • hasMore:额外结果标志

实施考虑

  1. 服务器应该

    • 返回按相关性排序的建议
    • 在适当的地方实现模糊匹配
    • 限制补全请求速率
    • 验证所有输入
  2. 客户端应该

    • 对快速补全请求进行去抖动
    • 在适当的地方缓存补全结果
    • 优雅地处理缺失或部分结果

安全

实现必须

  • 验证所有补全输入
  • 实施适当的速率限制
  • 控制对敏感建议的访问
  • 防止基于补全的信息泄露