使用说明

项目简介

Chef CLI 是 DevRev 提供的辅助命令行工具,用于加速 ADaaS (Application Development as a Service) 配方的开发过程。除了配方开发,Chef CLI 还可以作为 MCP (Model Context Protocol) 服务器运行,为大型语言模型 (LLM) 应用提供资源管理、工具执行和 Prompt 模板渲染等核心上下文服务。

主要功能点

  • 资源管理: 托管和管理应用程序所需的各种资源,例如配置数据、知识库等,并允许 LLM 客户端通过 MCP 协议访问这些资源。
  • 工具执行: 注册和执行外部工具,使 LLM 能够调用这些工具来扩展其功能,例如调用 API、访问数据库等。
  • Prompt 模板渲染: 定义和渲染 Prompt 模板,支持定制化的 LLM 交互模式,使得开发者可以灵活控制 LLM 的行为。
  • MCP 服务器: 通过 JSON-RPC 协议与 MCP 客户端通信,处理客户端的资源访问、工具调用和 Prompt 请求,并返回标准化的 JSON-RPC 响应。
  • 会话管理和能力声明: 支持会话管理,并向客户端声明服务器所提供的能力。

安装步骤

  1. 下载 Chef CLI: 访问 Releases 页面,根据您的操作系统选择合适的二进制文件下载。
  2. 安装到路径: 将下载的二进制文件放置到您的系统 PATH 环境变量包含的目录中,或者记住该文件的位置,以便在命令行中直接调用。假设您已将其添加到 PATH 环境变量,后续可以使用 'chef-cli' 命令。
  3. 安装自动补全 (可选):
    • Linux/Mac (Bash/ZSH): 在项目根目录下运行 './install_completions.sh' 脚本,并重启您的 shell。
    • PowerShell: 以管理员身份运行 'Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass',然后打开 PowerShell 配置文件(使用 'code $profile' 或 'notepad $profile' 命令),添加以下行,并将 '/path/to/this/repo' 替换为仓库的实际路径:
      /path/to/this/repo/autocomplete/chef-cli.ps1

服务器配置

MCP 客户端需要配置 Chef CLI 作为 MCP 服务器的启动信息。以下是一个 JSON 格式的配置示例,您可以根据实际情况进行调整。

{
  "serverName": "chef-cli-mcp-server",  // MCP 服务器名称,可以自定义
  "command": "chef-cli",                 // 启动 MCP 服务器的命令,这里假设 chef-cli 已添加到 PATH 环境变量
  "args": ["mcp", "server", "--port", "8080"]  // 启动参数,这里假设使用 "mcp server" 子命令启动 MCP 服务器,并指定端口为 8080。具体的参数需要参考 chef-cli 的文档或帮助信息。
  // 注意: 实际的启动参数需要参考 chef-cli 的官方文档,这里只是一个假设的示例。
  //      请查阅仓库文档 "docs/mcp.md" 或运行 "chef-cli mcp server --help" 命令获取准确的参数信息。
}

配置参数说明:

  • 'serverName': MCP 服务器的名称,用于在客户端标识和管理不同的 MCP 服务器连接。
  • 'command': 启动 MCP 服务器的可执行命令。通常是 'chef-cli',前提是您已将其添加到系统 PATH 环境变量。
  • 'args': 传递给 'command' 的命令行参数,用于配置服务器的行为。
    • '"mcp"', '"server"': 假设使用这两个子命令来指定 Chef CLI 以 MCP 服务器模式运行。请务必查阅文档确认实际的子命令或参数。
    • '"--port", "8080"': 假设使用 '--port' 参数指定服务器监听的端口号为 8080。请务必查阅文档确认实际的参数和端口配置方式。

请务必查阅仓库的文档 (特别是 'docs/mcp.md') 或运行 'chef-cli --help' 等命令来获取 Chef CLI 作为 MCP 服务器的准确启动命令和参数信息,并根据实际情况配置 MCP 客户端。

基本使用方法

  1. 启动 MCP 服务器: 根据上述服务器配置,使用 MCP 客户端配置的命令和参数启动 Chef CLI MCP 服务器。
  2. 配置 MCP 客户端: 在您的 LLM 应用或 MCP 客户端中,配置连接到 Chef CLI MCP 服务器。客户端需要能够发送符合 MCP 协议的 JSON-RPC 请求。
  3. 使用 MCP 功能: 通过 MCP 客户端向 Chef CLI MCP 服务器发送请求,例如:
    • 请求访问和获取托管的资源。
    • 请求执行已注册的工具,并传递必要的参数。
    • 请求渲染预定义的 Prompt 模板,以生成用于 LLM 交互的 Prompt。
  4. 接收响应: MCP 服务器将根据客户端的请求,返回 JSON-RPC 响应或发送通知。客户端需要解析这些响应并进行相应的处理。

详细的使用方法和 API 调用方式,请参考仓库文档 'docs/mcp.md' 和 MCP 协议的官方文档。

信息

分类

开发者工具