使用说明

项目简介

'Cheqd MCP Toolkit' 是一个围绕 Model Context Protocol (MCP) 构建的模块化框架，旨在标准化 AI 代理的交互方式，特别是在身份相关的工作流程中。该工具包使 AI 代理能够安全地管理去中心化身份 (DIDs)、可验证凭据和信任注册表，是 AI 驱动的身份系统的关键组件。开发者可以使用此仓库配置和部署 MCP 服务器，并集成各种可用的工具包，如 'credo-ts'，从而为 AI 应用提供强大的身份管理能力。

主要功能点

MCP 服务器核心功能: 实现标准的 MCP 服务器架构，能够处理来自 MCP 客户端的请求和响应。
工具化集成: 通过模块化的工具包（如 '@cheqd/mcp-toolkit-credo'）扩展服务器功能，当前主要关注去中心化身份 (DID) 和可验证凭据 (VC) 的管理。
可配置的工具集: 允许用户根据需要配置和启用不同的工具，例如用于 DID 文档解析、创建 DID、管理 Schema 和 Credential Definition 等工具。
基于 Stdio 的传输协议: 使用 Stdio 作为默认的传输协议，方便本地开发和部署。
环境配置: 通过环境变量灵活配置服务器和工具的行为，例如 Credo 代理的端口、名称和助记词等。

安装步骤

安装 Node.js 和 npm: 确保你的开发环境中已安装 Node.js 和 npm。
安装 @cheqd/mcp-toolkit: 可以通过 npm 全局安装 '@cheqd/mcp-toolkit' 包，以便在命令行中直接运行 MCP 服务器。
```
npm install -g @cheqd/mcp-toolkit
```
或者，如果你希望在项目本地使用，可以在你的项目目录中安装：
```
npm install @cheqd/mcp-toolkit
```

服务器配置

MCP 客户端（如 Claude Desktop 或 Cursor）需要配置 MCP 服务器的启动命令才能连接。以下是针对 'Cheqd MCP Toolkit' 的配置示例，你需要将这段 JSON 配置添加到你的 MCP 客户端配置文件中（例如 'claude_desktop_config.json' 或 '.cursor/mcp.json'）。

{
    "mcpServers": {
        "Cheqd": {
            "command": "npx",
            "args": [
                "-y",
                "@cheqd/mcp-toolkit"
            ],
            "env": {
                "TOOLS": "credo",
                "CREDO_PORT": "3000",
                "CREDO_NAME": "your-agent-name",
                "CREDO_CHEQD_TESTNET_MNEMONIC": "your-mnemonic-phrase"
            }
        }
    }
}

配置参数说明：

'"Cheqd"': 服务器名称，可以自定义，用于在 MCP 客户端中标识该服务器。
'"command": "npx"': 指定启动服务器的命令为 'npx'，用于执行 npm 包。
'"args": ["-y", "@cheqd/mcp-toolkit"]': 'npx' 命令的参数，'-y' 表示自动确认安装包，'@cheqd/mcp-toolkit' 是要执行的 npm 包，即 MCP 服务器的入口。
'"env"': 环境变量配置，用于配置 MCP 服务器和其集成的工具：
- '"TOOLS": "credo"': 指定启用的工具包，这里启用的是 'credo' 工具包，用于 DID 和 VC 管理。可以配置多个工具，用逗号分隔，例如 '"TOOLS": "credo, other-tool"'.
- '"CREDO_PORT": "3000"': 'credo' 工具包使用的端口号，默认为 '3000'，可以根据需要修改。
- '"CREDO_NAME": "your-agent-name"': 'credo' 代理的名称，请替换为你的代理名称。
- '"CREDO_CHEQD_TESTNET_MNEMONIC": "your-mnemonic-phrase"': 重要 'credo' 代理连接 Cheqd Testnet 网络所需的助记词。请务必替换为你自己的助记词，并妥善保管，切勿泄露。 如果要连接 Mainnet，可以使用 'CREDO_CHEQD_MAINNET_MNEMONIC' 环境变量。

基本使用方法

启动 MCP 服务器: 配置好 MCP 客户端后，当客户端尝试连接名为 "Cheqd" 的 MCP 服务器时，客户端会自动根据配置启动服务器。或者，你也可以在命令行中手动启动服务器（如果你全局安装了 '@cheqd/mcp-toolkit'）：
```
npx -y @cheqd/mcp-toolkit
```
请确保在启动服务器前，已经设置了必要的环境变量，例如 'TOOLS', 'CREDO_PORT', 'CREDO_NAME', 'CREDO_CHEQD_TESTNET_MNEMONIC' 等。
在 MCP 客户端中使用工具: 服务器成功启动并连接后，你可以在 MCP 客户端中调用服务器提供的工具。例如，你可以使用 "resolve-did" 工具来解析 DID 文档，或者使用 "create-schema" 工具来创建新的 Schema。具体的工具和使用方法取决于客户端的界面和功能。

注意: 首次运行服务器时，'npx' 可能会先下载 '@cheqd/mcp-toolkit' 包及其依赖，这可能需要一些时间。请耐心等待。

关键词