EasyReportsMCPServer / PROJECT_STRUCTURE.md
JC321's picture
Upload 10 files
7dde4c5 verified

📁 项目结构

EasyReportDateMCP/
│
├── 📄 README.md                    # 项目主文档
├── 📘 USAGE.md                     # 使用指南
├── 📋 PROJECT_STRUCTURE.md         # 本文件
│
├── 🐳 Dockerfile                   # HF Space 部署配置
├── 📦 requirements.txt             # Python 依赖
├── 🙈 .gitignore                   # Git 忽略规则
│
├── 🚀 mcp_server_sse.py            # MCP Server 主程序(SSE 传输)
├── 📊 edgar_client.py              # SEC EDGAR 数据客户端
├── 📈 financial_analyzer.py        # 财务数据分析器
│
└── 🧪 test_mcp_sse.py              # 测试脚本

核心文件说明

📄 README.md

项目主文档,包含:

  • 快速开始指南
  • 可用工具列表
  • 使用示例
  • 技术栈说明

📘 USAGE.md

详细使用指南,包含:

  • 客户端配置步骤
  • 7 个工具的详细说明
  • 实际使用场景
  • 故障排除

🚀 mcp_server_sse.py

MCP Server 主程序(583 行):

  • FastAPI 应用
  • SSE 传输实现
  • 7 个 MCP 工具定义
  • 格式化输出逻辑
  • 健康检查和监控

📊 edgar_client.py

SEC EDGAR 客户端(600+ 行):

  • 公司搜索
  • 公司信息获取
  • 财报文件检索
  • XBRL 数据解析
  • 财务数据提取

📈 financial_analyzer.py

财务分析器(340+ 行):

  • 多年数据提取
  • 数据格式化
  • 智能搜索
  • 最新数据获取

🐳 Dockerfile

Docker 部署配置:

  • Python 3.10 基础镜像
  • 依赖安装
  • 应用文件复制
  • Uvicorn 启动命令

📦 requirements.txt

Python 依赖:

fastapi==0.109.0
uvicorn[standard]==0.27.0
pydantic==2.5.3
sec-edgar-api==1.1.0
requests==2.31.0

🧪 test_mcp_sse.py

测试脚本(232 行):

  • 健康检查测试
  • MCP 协议测试
  • 工具调用测试
  • SSE 连接测试

部署文件

HF Space 必需

  • README.md (HF Space 主页显示)
  • Dockerfile (构建镜像)
  • requirements.txt (依赖)
  • mcp_server_sse.py (主程序)
  • edgar_client.py (核心库)
  • financial_analyzer.py (核心库)

可选文件

  • 📘 USAGE.md (用户文档)
  • 🧪 test_mcp_sse.py (测试)
  • 📋 PROJECT_STRUCTURE.md (本文件)

代码统计

文件 行数 说明
mcp_server_sse.py 583 MCP Server 主程序
edgar_client.py 600+ SEC 数据客户端
financial_analyzer.py 340+ 财务分析器
test_mcp_sse.py 232 测试套件
总计 ~1,800 核心代码行数

依赖关系

mcp_server_sse.py
    ├── edgar_client.py
    │   └── sec-edgar-api
    │   └── requests
    │
    └── financial_analyzer.py
        └── edgar_client.py

数据流

MCP Client (Claude Desktop)
    ↓ SSE
MCP Server (mcp_server_sse.py)
    ↓
Financial Analyzer (financial_analyzer.py)
    ↓
EDGAR Client (edgar_client.py)
    ↓ HTTPS
SEC EDGAR API

开发工作流

1. 本地开发

# 启动服务器
python mcp_server_sse.py

# 运行测试
python test_mcp_sse.py

2. 部署到 HF Space

git add .
git commit -m "Update"
git push

3. 验证部署

curl https://jc321-easyreportsmcpserver.hf.space/health

项目特点

简洁 - 核心文件少,结构清晰
专注 - 只保留 MCP Server 相关代码
完整 - 包含服务器、测试、文档
可维护 - 代码组织良好,易于理解
生产就绪 - 可直接部署到 HF Space


总大小: ~70 KB (不含 Python 缓存)
文件数: 9 个核心文件
依赖数: 5 个 Python 包