sec-edgar-mcp

🚀 SEC EDGAR MCP 项目文档

SEC EDGAR MCP 项目提供了一个接口，让 AI 模型能够借助 Model Context Protocol (MCP) 访问美国证券交易委员会（SEC）的 EDGAR 数据库。EDGAR 是 SEC 的电子化公司文件提交系统，涵盖了上市公司的监管文件，像 10 - K、8 - K 等重要财务报告。通过 MCP 协议，AI 模型可调用一系列工具来查询和分析 SEC 的公开数据，实现对上市公司财务状况、治理结构等信息的自动化获取与处理。

🚀 快速开始

SEC EDGAR MCP 项目为 AI 模型访问 SEC 的 EDGAR 数据库搭建了桥梁，借助 MCP 协议，可利用多种工具对公开数据进行查询和分析。

✨ 主要特性

• 提供标准化接口，使 AI 模型能通过 MCP 协议访问 SEC 的 EDGAR 数据库。
• 集成多种工具，可对上市公司的监管文件进行查询和分析。
• 实现对上市公司财务状况、治理结构等信息的自动化获取和处理。

📦 安装指南

文档未提及安装步骤，此部分跳过。

💻 使用示例

基础用法

1. 获取提交记录 (get_submissions)

{
  "jsonrpc": "2.0",
  "method": "get_submissions",
  "params": {
    "cik": "0001369748"
  },
  "id": 1
}

此工具用于检索指定公司（通过 CIK 或 Ticker）的所有 SEC 提交记录。参数方面，cik 是公司的 Central Index Key（可选，若未提供，则需提供 ticker）；ticker 是公司的股票代码（可选，若未提供，则需提供 cik）。返回的是公司提交的所有 filings 的元数据列表，包含 accessionNumber（提交记录的唯一标识符）、formType（提交的表格类型，如 10 - K, 8 - K 等）、actionDate（提交日期）、filedAt（文件的实际提交时间）、description（表格的简要描述）等字段。

2. 获取 filings 内容 (get_filing)

{
  "jsonrpc": "2.0",
  "method": "get_filing",
  "params": {
    "accessionNumber": "0001369748-23-00001"
  },
  "id": 1
}

该工具用于返回指定提交记录的完整内容。参数为 accessionNumber（提交记录的唯一标识符），返回的是提交记录的 JSON 格式内容，包含 infoTable（基本信息表）、formData（表单数据）、XBRLData（可扩展商业报告语言 (XBRL) 数据，若适用）等字段。

3. 获取 XBRL 数据 (get_xbrl)

{
  "jsonrpc": "2.0",
  "method": "get_xbrl",
  "params": {
    "accessionNumber": "0001369748-23-00001"
  },
  "id": 1
}

此工具用于返回指定提交记录中的 XBRL (可扩展商业报告语言) 数据。参数是 accessionNumber（提交记录的唯一标识符），返回的是 XBRL 格式的财务数据，包含收入、利润、负债等关键指标。

📚 详细文档

可用工具 🔧

1. 获取提交记录 (get_submissions)

• 功能：检索指定公司（通过 CIK 或 Ticker）的所有 SEC 提交记录。
• 参数：
  • cik：公司的 Central Index Key（可选，如果未提供，则需要提供 ticker）
  • ticker：公司的股票代码（可选，如果未提供，则需要提供 cik）
• 返回：返回公司提交的所有 filings 的元数据列表，包括以下字段：
  • accessionNumber：提交记录的唯一标识符
  • formType：提交的表格类型（如 10 - K, 8 - K 等）
  • actionDate：提交日期
  • filedAt：文件的实际提交时间
  • description：表格的简要描述

2. 获取 filings 内容 (get_filing)

• 功能：返回指定提交记录的完整内容。
• 参数：
  • accessionNumber：提交记录的唯一标识符
• 返回：返回提交记录的 JSON 格式内容，包括以下字段：
  • infoTable：基本信息表
  • formData：表单数据
  • XBRLData：可扩展商业报告语言 (XBRL) 数据（如果适用）

3. 获取 XBRL 数据 (get_xbrl)

• 功能：返回指定提交记录中的 XBRL (可扩展商业报告语言) 数据。
• 参数：
  • accessionNumber：提交记录的唯一标识符
• 返回：返回 XBRL 格式的财务数据，包括收入、利润、负债等关键指标。

注意事项 🛠️

• 所有工具的调用都需要提供有效的 CIK 或 Ticker。
• 调用前请仔细阅读 SEC 的 官方文档 和 MCP 协议的要求。
• 由于 SEC 数据库的限制，部分历史数据可能无法访问。

架构 🗖️

项目的架构如下：

1. MCP 客户端：负责接收和处理来自 AI 模型的请求，并将其转发到服务器。
2. MCP 服务器：负责解析请求、调用相应的 EDGAR API，并将结果返回给客户端。
3. EDGAR REST API：SEC 提供的公共接口，用于查询和获取 filings 数据。

整个流程如下：

AI 模型 -> MCP 客户端 -> MCP 服务器 -> EDGAR REST API -> 返回结果

参考资料 📚

1. SEC 官网 (官网，2024)
2. MCP 协议文档
3. EDGAR API 文档

🔧 技术细节

文档未提供具体技术实现细节，此部分跳过。

📄 许可证

本项目在 MIT 许可证下开源，允许用户自由使用、修改和分发。完整许可内容请参考 LICENSE 文件。