使用说明

项目简介

Cyberlink MCP服务器是一个基于Model Context Protocol (MCP) 构建的后端应用,旨在为LLM客户端提供访问和操作Cosmos区块链上CW-Social智能合约中Cyberlink数据的标准化接口。通过此服务器,用户可以方便地创建、更新、查询和删除Cyberlink,构建基于区块链的语义关系网络。

主要功能点

  • 全面的CRUD操作: 支持对Cyberlink数据的创建、读取、更新和删除操作。
  • 命名Cyberlink: 支持创建带有名称标识符的Cyberlink。
  • 批量操作: 支持批量创建Cyberlink,提高效率。
  • 丰富的查询能力: 提供多种查询方式,包括ID查询、格式化ID查询、所有Cyberlink查询(分页)、所有命名Cyberlink查询、所有者查询、时间范围查询等。
  • 交易状态跟踪: 可以查询区块链交易的状态,并获取Cyberlink的ID信息。
  • 输入验证与错误处理: 具备输入数据验证和完善的错误处理机制。
  • 集成Cursor IDE和Claude Desktop: 可以直接与Cursor IDE和Claude Desktop等MCP客户端集成。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/dasein108/mcp-cw-graph.git
    cd mcp-cw-graph
  2. 安装依赖:
    npm install
  3. 构建项目:
    npm run build

服务器配置

要将此MCP服务器与MCP客户端(如Cursor IDE 或 Claude Desktop)集成,您需要配置客户端的MCP设置。配置文件通常是JSON格式。以下是针对 'cw-graph' 服务器的配置示例,请根据您的实际情况修改:

Cursor IDE 配置示例 ( '~/.cursor/mcp.json' ) 或 Claude Desktop 配置示例:

{
    "mcpServers": {
        "cw-graph": {
            "command": "node",
            "args": ["<项目路径>/dist/index.js"],
            "env": {
                "NODE_URL": "<Cosmos节点URL>",
                "WALLET_MNEMONIC": "<钱包助记词>",
                "CONTRACT_ADDRESS": "<合约地址>"
            }
        }
    }
}

配置参数说明:

  • 'server name': 'cw-graph' - 服务器名称,可以自定义,客户端通过此名称识别服务器。
  • 'command': 'node' - 启动服务器的命令,这里使用 Node.js 运行 JavaScript 文件。
  • 'args': '["<项目路径>/dist/index.js"]' - 启动命令的参数,指向编译后的服务器入口文件 'index.js' 的绝对路径。 请将 '<项目路径>' 替换为您的 'mcp-cw-graph' 项目在您本地文件系统中的绝对路径。 例如: '["/Users/yourname/Documents/mcp-cw-graph/dist/index.js"]'。
  • 'env': 环境变量配置,服务器运行时需要的配置信息。
    • 'NODE_URL': '<Cosmos节点URL>' - 请替换为您的 Cosmos 区块链节点的 URL 地址,例如 'http://localhost:26657' 或远程节点的地址。
    • 'WALLET_MNEMONIC': '<钱包助记词>' - 请替换为您的 Cosmos 钱包的助记词,用于服务器进行交易签名。 请务必妥善保管您的助记词,避免泄露!
    • 'CONTRACT_ADDRESS': '<合约地址>' - 请替换为您部署的 CW-Social 智能合约的地址

重要提示:

  • 请确保您已安装 Node.js 16+ 环境。
  • 配置中的路径、URL、助记词和合约地址需要根据您的实际环境进行替换。
  • 配置完成后,需要重启 Cursor IDE 或 Claude Desktop 使配置生效。

基本使用方法

配置完成后,在 Cursor IDE 或 Claude Desktop 中,您应该能够使用以下工具 (Tools) 与 Cyberlink MCP 服务器进行交互。这些工具通常可以通过IDE的命令面板或特定的上下文菜单访问。

工具列表 (Tools):

创建和修改 (Creation and Modification)

  • 'create_cyberlink': 创建新的 Cyberlink。
  • 'create_named_cyberlink': 创建带有名称的 Cyberlink。
  • 'create_cyberlinks': 批量创建 Cyberlink。
  • 'update_cyberlink': 更新已存在的 Cyberlink。
  • 'delete_cyberlink': 删除 Cyberlink。

基本查询 (Basic Queries)

  • 'query_by_id': 通过数字 ID 查询 Cyberlink。
  • 'query_by_formatted_id': 通过格式化 ID 查询 Cyberlink。
  • 'query_cyberlinks': 查询所有 Cyberlink (分页)。
  • 'query_named_cyberlinks': 查询所有命名 Cyberlink。
  • 'query_by_ids': 通过多个数字 ID 查询 Cyberlink。

高级查询 (Advanced Queries)

  • 'query_by_owner': 通过所有者地址查询 Cyberlink。
  • 'query_by_time_range': 通过创建时间范围查询 Cyberlink。
  • 'query_by_time_range_any': 通过创建或更新时间范围查询 Cyberlink。

系统查询 (System Queries)

  • 'query_last_id': 获取最后一个分配的 Cyberlink ID。
  • 'query_config': 查询合约配置信息。
  • 'query_debug_state': 查询合约调试状态 (管理员权限)。
  • 'get_tx_status': 检查交易状态并获取 Cyberlink ID。

每个工具的具体使用方法和参数,请参考仓库 'README.md' 文件中 "MCP Tools" 和 "Query Parameters" 部分的详细说明。

信息

分类

数据库与文件