使用说明（Markdown 格式）

项目简介

Edge Trade MCP 服务器是一套面向大语言模型的后端服务，按照 MCP 规范提供标准化的上下文服务。通过 JSON-RPC 与客户端通信，处理请求、返回响应，并支持多种传输方式，统一管理资源、工具和交互模板。

主要功能点

• 资源与数据访问：提供面向 Liquidity、市场、投资组合等资源的查询能力，便于 LLM 客户端获取必要信息。
• 工具注册与执行：内置若干工具（如 search、inspect、screen、portfolio、trade、alerts），允许 LLM 客户端调用外部功能并获得结构化结果。
• 会话与订阅能力：支持订阅式推送（如 alerts）以及基于轮询的事件获取，方便实现实时交互场景。
• 多传输协议支持：标准输入输出（stdio）、Server-Sent Events（SSE）HTTP 服务、可扩展的 HTTP 流服务等，适配不同客户端接入方式。
• JSON-RPC 风格的请求/响应：服务器端通过 MCP 的约定格式处理请求、返回结果或错误信息，确保互操作性。
• 安全与认证：客户端通过 API Key 进行认证，服务器在连接阶段校验并在错误时返回参考文档中的错误指引。
• 完整类型定义与文档化：使用 serde 和 schemars 定义输入输出结构，便于客户端在集成阶段进行校验与推断。

安装步骤

• 克隆或下载源码后，在项目根目录执行构建：
  • cargo build --release
• 运行可执行文件（构建产物通常在 target/release/ 目录下，名称为 edge）：
  • edge --api-key YOUR_API_KEY --transport stdio
  • edge --api-key YOUR_API_KEY --transport sse --host 0.0.0.0 --port 3000
  • edge --api-key YOUR_API_KEY --transport http --host 0.0.0.0 --port 3000
• 说明：
  • 该服务器默认通过 Iris 服务端进行数据请求与聚合，需要提供有效的 API Key。
  • 如需通过不同传输方式接入，请按照上面的示例启动对应模式。

服务器配置

以下配置用于 MCP 客户端在启动时与 MCP 服务器建立连接。该配置仅用于描述服务器端实例如何被客户端发现与连接，不包含客户端实现细节。

{ "name": "edge", "command": "npx", "args": ["-y", "@edgedottrade/mcp", "--api-key", "sk-your-key-here"] // 注：command/args 为 MCP 客户端用于启动服务器的命令与参数，实际密钥请替换为你的 API Key。 }

说明

• server name: edge
• command: npx（用于直接运行 Node.js 包的快速启动方式）或等效的本地二进制启动方式
• args: 启动参数，应包含包名与需要的身份验证信息（如 --api-key），以便 MCP 客户端连接到服务器
• 该配置用于描述客户端应如何启动并连接到服务器，客户端本身不需要重复实现服务器端逻辑

基本使用方法

• 启动服务器后，客户端通过 MCP 的 JSON-RPC 请求与之交互，常见操作包括：
  • 调用工具（如 search、inspect、screen、portfolio、trade、alerts）并获取结构化结果
  • 订阅实时事件（如 alerts）并接收推送数据
  • 通过 HTTP/SSE/stdio 等传输方式与服务器建立连接，灵活集成到不同的 LLM 应用
• 参考官方文档了解各工具的输入输出结构与可用的视图/参数
• 如遇授权或请求错误，请检查 API Key 及服务器日志中的错误信息，必要时参考文档中的错误定位建议