使用说明

项目简介

SEC EDGAR MCP服务器是一个基于Model Context Protocol (MCP) 构建的应用后端，它充当AI模型和美国证券交易委员会 (SEC) EDGAR数据库之间的桥梁。该服务器实现了MCP协议，并提供了一系列工具，使得AI模型能够以标准化的方式访问EDGAR数据库中丰富的公司财务数据，从而支持金融研究、投资分析和企业透明度等应用场景。

主要功能点

数据访问能力: 提供对SEC EDGAR数据库的访问，包括公司提交的文件、财务概念、公司事实和XBRL数据。
工具 (Tools): 注册并暴露了一系列工具，允许MCP客户端（如AI模型）调用以检索不同的EDGAR数据，例如：
- 'get_submissions': 获取公司提交的文件列表。
- 'get_company_concepts': 获取公司特定财务概念的数据。
- 'get_company_facts': 获取公司的所有财务事实数据。
- 'get_xbrl_frames': 查询跨公司或时间段的XBRL数据。
标准化接口: 基于MCP协议的JSON-RPC接口，方便与各种MCP客户端集成。

安装步骤

克隆仓库:

git clone https://github.com/stefanoamorelli/sec-edgar-mcp.git
cd sec-edgar-mcp

安装依赖: 确保已安装 Python 3.9+。安装所需的Python包，包括 'mcp' 框架和 'secedgar' SDK：

pip install mcp secedgar python-dotenv

配置 SEC EDGAR API User-Agent: SEC API 要求所有请求都包含 User-Agent 字符串。在项目目录下创建 '.env' 文件，并添加您的 User-Agent 信息，例如：
```
SEC_EDGAR_USER_AGENT="Your Name ([email protected])"
```
请将 "Your Name ([email protected])" 替换为您自己的姓名和邮箱。服务器将从环境变量中加载此信息以向EDGAR验证身份。

启动 MCP 服务器: 运行以下命令启动服务器：

mcp install sec_edgar_mcp/server.py --env-file .env --name "SEC EDGAR MCP Server"

服务器启动后，将注册其提供的工具并等待客户端连接。您应该能在日志中看到服务器已准备就绪的信息。

服务器配置

MCP客户端需要配置以下信息才能连接到 SEC EDGAR MCP 服务器。以下是配置示例 (JSON 格式):

{
  "server name": "SEC EDGAR MCP Server",
  "command": "mcp",
  "args": [
    "run",
    "SEC EDGAR MCP Server"
  ]
}

配置参数说明:

'"server name"': 服务器名称，必须与启动命令中 '--name' 参数的值 '"SEC EDGAR MCP Server"' 一致。
'"command"': 运行MCP服务器的命令，通常为 '"mcp"'。
'"args"': 传递给 'mcp' 命令的参数列表，用于指定运行哪个服务器实例。
- '"run"': 'mcp' 命令的子命令，用于运行已安装的服务器。
- '"SEC EDGAR MCP Server"': 要运行的服务器实例名称，必须与启动命令中 '--name' 参数的值 '"SEC EDGAR MCP Server"' 一致。

基本使用方法

确保 MCP 服务器已成功启动并运行。
在您的 MCP 客户端中，配置上述服务器连接信息。
客户端连接到服务器后，可以发现并调用服务器提供的工具，例如 'get_submissions'、'get_company_concepts' 等。
调用工具时，需要根据工具的参数要求提供相应的参数，例如公司 CIK、财务概念名称等。
服务器将返回 JSON-RPC 响应，其中包含从 SEC EDGAR 数据库检索的数据。

请参考仓库的 README 文件和工具的详细描述，了解每个工具的具体参数和使用方法。

关键词