Story SDK MCP Server 使用说明

项目简介

Story SDK MCP Server 是 Story MCP Hub 项目中的一个核心组件,它基于 Model Context Protocol (MCP) 构建,旨在为 AI Agent 提供桥梁,使其能够便捷地与 Story Protocol SDK 进行交互。通过 Story SDK MCP Server,AI Agent 可以调用预设的工具来管理和操作 Story Protocol 生态系统内的知识产权 (IP) 资产,例如上传内容到 IPFS、创建 IP 资产元数据、铸造和注册 IP 资产、管理 License 等。

主要功能点

  • IPFS 工具:

    • 'upload_image_to_ipfs': 将图片上传到 IPFS (InterPlanetary File System) 网络,并返回 IPFS URI,用于内容存储和去中心化访问。
    • 'create_ip_metadata': 创建符合 NFT 和 IP 规范的元数据,包括名称、描述、图片链接等信息,并上传到 IPFS,为后续的 IP 资产注册和管理提供数据基础。
  • IP 管理工具:

    • 'get_license_terms': 查询指定 License Terms ID 的许可条款详情,帮助了解 IP 资产的授权方式和条件。
    • 'mint_license_tokens': 为指定的 IP 资产和许可条款铸造 License Token,实现 IP 资产的授权和分发。
    • 'send_ip': 将 IP Token (Story Protocol 的原生代币) 发送给其他地址,用于价值转移和交易。
    • 'mint_and_register_ip_with_terms': 一键完成 NFT 铸造、注册为 IP 资产,并附加许可条款,简化 IP 资产的创建和授权流程。
    • 'create_spg_nft_collection': 创建 SPG (Story Protocol Group) NFT 合集,用于批量管理和发行 IP 资产。

安装步骤

  1. 环境准备: 确保已安装 Python 3.12+ 和 UV 包管理器。UV 包管理器安装命令如下:
    curl -LsSf https://astral.sh/uv/install.sh | sh
  2. 克隆仓库: 将 Story MCP Hub 仓库克隆到本地:
    git clone https://github.com/piplabs/story-mcp-hub.git
    cd story-mcp-hub
  3. 安装依赖: 使用 UV 包管理器安装项目依赖:
    uv sync
  4. 配置环境变量: 进入 'story-sdk-mcp' 目录,复制 '.env.example' 文件为 '.env',并根据 '.env' 文件中的注释,配置以下环境变量:
    cd story-sdk-mcp
    cp .env.example .env
    # 编辑 .env 文件
    • 'WALLET_PRIVATE_KEY': 你的钱包私钥,用于签名交易。
    • 'RPC_PROVIDER_URL': Story Protocol 节点的 RPC URL,例如 'https://mainnet.storyrpc.io' 或 'https://aeneid.explorer.story.foundation'。
    • 'PINATA_JWT' (可选): Pinata API 的 JWT 密钥,如果需要使用 IPFS 相关工具(如 'upload_image_to_ipfs' 和 'create_ip_metadata'),则需要配置。

服务器配置

以下 JSON 配置信息用于 MCP 客户端 (如 Cursor 或 Claude Desktop) 连接 Story SDK MCP Server。

{
  "serverName": "story-sdk-mcp",
  "command": "uv",
  "args": [
    "--directory",
    "~/path/to/story-mcp-hub/story-sdk-mcp", // 请替换为 story-sdk-mcp 目录的实际路径
    "run",
    "server.py"
  ]
}

配置参数说明:

  • 'serverName': MCP 服务器的名称,可以自定义,例如 "Story SDK MCP Server"。
  • 'command': 启动服务器的命令,这里使用 'uv' 包管理器来运行 Python 脚本。
  • 'args': 命令参数列表:
    • '--directory': 指定服务器启动的工作目录为 'story-sdk-mcp' 目录。请务必将 '~/path/to/story-mcp-hub/story-sdk-mcp' 替换为你本地 'story-sdk-mcp' 目录的实际绝对路径
    • 'run': 使用 'uv run' 命令来运行 Python 脚本。
    • 'server.py': 指定要运行的服务器脚本为 'server.py'。

MCP客户端配置:

  • Cursor: 在 'Cursor Settings' > 'Features' > 'MCP' 中,点击 '+ Add New MCP Server' 按钮,按照上述配置信息填写表单。
  • Claude Desktop: 编辑 '~/Library/Application\ Support/Claude/claude_desktop_config.json' 文件,将上述 JSON 配置信息添加到 'mcpServers' 字段中。

基本使用方法

  1. 启动 Story SDK MCP Server:

    cd story-sdk-mcp
    uv run mcp dev server.py
  2. 在 MCP 客户端 (如 Cursor 或 Claude Desktop) 中配置并连接到 Story SDK MCP Server。

  3. 在 MCP 客户端中,可以使用自然语言指令调用 Story SDK MCP Server 提供的工具。例如,在 Cursor 中,你可以指示 Agent 使用工具来:

    • 上传图片到 IPFS:'upload image of a cat to ipfs'
    • 创建 IP 元数据:'create ip metadata for a digital artwork named "Sunrise" with description "A beautiful sunrise over the mountains"'
    • 铸造和注册 IP 资产:'mint and register ip asset with commercial revenue share 10% and derivatives allowed for my artwork metadata'

    Agent 会根据你的指令,自动调用相应的 MCP 工具,并请求你的授权执行操作。

请参考 Story MCP Hub 仓库 README 获取更详细的信息和示例。

信息

分类

开发者工具