EdgarTools MCP 服务器使用说明

简介
- 这是一个基于 MCP 的服务器端实现，旨在为大语言模型客户端提供规范化的上下文资源、工具调用能力以及可定制的提示模板。服务器负责会话管理、能力声明，并通过 JSON-RPC 与客户端进行通信，支持多种传输通道以适配不同的集成场景。
主要功能点
- 资源托管与数据访问：通过 MCP 的资源模型暴露公司、财务数据、文档等资源，LLM 客户端可以读取、查询、过滤。
- 工具注册与执行：在 MCP 服务端注册可供 LLM 调用的外部功能（Tools），LLM 可以通过 JSON-RPC 调用执行。
- Prompt 模板定义与渲染：提供可自定义的 Prompt 模板，支持不同的交互模式，提升与 LLM 的对话效果。
- JSON-RPC 协议：与客户端进行标准化请求/响应通信，统一格式、清晰的错误处理和通知。
- 会话与能力声明：跟踪会话状态、声明当前服务器的能力与可用资源、工具、模板集合等。
- 传输协议扩展：支持多种传输协议（如 Stdio、SSE、WebSocket），在不同运行环境下有更灵活的接入方式。
安装步骤
- 直接安装 EdgarTools 包，并确保依赖在运行环境中就绪（镜像或本地环境皆可）。
- 启动 MCP 服务器模块：通过命令行执行相应的 MCP 服务入口，开启服务端并对外暴露 JSON-RPC API。
服务器配置（MCP 客户端需要的最小字段）
- MCP 客户端需要配置一个服务器条目，包含服务器名称、启动命令及参数等信息，用于建立与 MCP 服务器的连接。下面给出配置示例说明（文本描述，便于理解，不作为代码块呈现）：
- server_name: edgartools
  - 描述：该名称用于在客户端端配置中唯一标识本 MCP 服务器。
- command: python
  - 描述：启动服务器所使用的命令（此处使用 Python 解释器）。
- args: ["-m", "edgar.ai"]
  - 描述：启动参数，指向进入 MCP 服务实现的入口模块。
- env: { "EDGAR_IDENTITY": "Your Name [email protected]" }
  - 描述：用于身份标识，可能用于对 SEC API 的请求鉴权与审计。
- 备注：
  - 以上配置通常用于 Claude Desktop 等客户端的 MCP 设置中。具体的客户端 JSON 配置格式如其文档所示（请参考客户端文档中的 mcpServers 配置项），其中 server_name 对应上面的 server_name，command/args/env 对应启动信息和环境变量。
- 另外，文档中也给出 Claude Desktop 的配置片段示意，通常类似如下结构（文本描述，不直接作为代码）：
  - mcpServers.edgartools:
    - command: "python"
    - args: ["-m", "edgar.ai"]
    - env: EDGAR_IDENTITY: "Your Name [email protected]"
- 说明：MCP 客户端并不需要实现服务器端逻辑，只需要知道服务器的启动命令和必要参数即可通过 MCP 协议进行交互。
基本使用方法
- 1. 在后端准备好 MCP 服务端实现并确保可启动：
  - 运行启动命令：python -m edgar.ai（示例入口，实际入口以仓库实现为准）
  - 确保 EDGAR 身份信息正确设置（如 EDGAR_IDENTITY 环境变量）
- 1. 在客户端配置中添加 MCP 服务器条目（如 Claude Desktop 配置中的 mcpServers）
  - 指定 server_name、command、args、env 等字段，使客户端能够连接并通过 MCP 调用资源、工具和 Prompts。
- 1. 通过客户端发送 MCP 请求（JSON-RPC），获取资源、调用工具、获取并渲染 Prompt。
- 1. 服务器端将 JSON-RPC 请求转换为对应的资源检索、工具调用和提示渲染逻辑，并返回标准化的 JSON-RPC 响应。
- 1. 如需运维与监控，请结合服务器日志、会话状态和能力声明进行管理。
说明与建议
- 若要在本地复现 MCP 服务，请确保 Python 环境中具备 edgar.ai 相关模块及其依赖（具体版本以仓库要求为准）。
- MCP 服务应实现对资源、工具、Prompts 的完整暴露、注册、查询、执行和渲染能力，以及对不同传输通道的支持能力。
- 文档中提到的“生产就绪 MCP 服务器”应包含完善的错误处理、身份校验、并发请求处理、以及对多客户端的并发会话支持。
参考与扩展
- 客户端集成示例、Claude Desktop 配置、以及服务器入口相关实现均可在仓库中的 edgar.ai 子模块或相关文档中找到。

关键词

EdgarTools MCP 服务器使用说明

信息