Spaces:
Sleeping
Sleeping
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,12 +1,127 @@
|
|
| 1 |
---
|
| 2 |
-
title:
|
| 3 |
-
emoji:
|
| 4 |
-
colorFrom:
|
| 5 |
-
colorTo:
|
| 6 |
sdk: docker
|
| 7 |
-
pinned:
|
| 8 |
license: mit
|
| 9 |
-
|
|
|
|
| 10 |
---
|
| 11 |
|
| 12 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
title: SEC Financial Report MCP Server
|
| 3 |
+
emoji: π
|
| 4 |
+
colorFrom: blue
|
| 5 |
+
colorTo: green
|
| 6 |
sdk: docker
|
| 7 |
+
pinned: true
|
| 8 |
license: mit
|
| 9 |
+
app_port: 7860
|
| 10 |
+
short_description: MCP Server for SEC EDGAR financial data with remote access
|
| 11 |
---
|
| 12 |
|
| 13 |
+
# π SEC Financial Report MCP Server
|
| 14 |
+
|
| 15 |
+
**Model Context Protocol Server** for SEC EDGAR financial data analysis.
|
| 16 |
+
|
| 17 |
+
π **Remote Access** - Connect from Claude Desktop, Cline, or any MCP client
|
| 18 |
+
β¨ **Natural Language** - Query financial data through conversation
|
| 19 |
+
π **Formatted Output** - Get beautiful, AI-ready responses
|
| 20 |
+
|
| 21 |
+
## π Features
|
| 22 |
+
|
| 23 |
+
- **Company Search**: Search companies by name, ticker, or CIK
|
| 24 |
+
- **Company Info**: Industry, SIC code, fiscal year details
|
| 25 |
+
- **SEC Filings**: 10-K, 10-Q, 20-F reports with dates and links
|
| 26 |
+
- **Financial Data**: Revenue, Net Income, EPS, Cash Flow
|
| 27 |
+
- **Multi-Year Analysis**: Comprehensive metrics extraction
|
| 28 |
+
- **Smart Formatting**: Beautiful, AI-ready output with emoji
|
| 29 |
+
|
| 30 |
+
## π Supported Data
|
| 31 |
+
|
| 32 |
+
- **Report Types**: 10-K (Annual), 10-Q (Quarterly), 20-F (Foreign)
|
| 33 |
+
- **Standards**: US-GAAP, IFRS
|
| 34 |
+
- **Metrics**: Revenue, Net Income, EPS, Operating Expenses, Cash Flow
|
| 35 |
+
|
| 36 |
+
## π Quick Start
|
| 37 |
+
|
| 38 |
+
### 1. Add to Your MCP Client
|
| 39 |
+
|
| 40 |
+
**Claude Desktop** (`%APPDATA%\Claude\claude_desktop_config.json`):
|
| 41 |
+
```json
|
| 42 |
+
{
|
| 43 |
+
"mcpServers": {
|
| 44 |
+
"sec-financial-data": {
|
| 45 |
+
"url": "https://jc321-easyreportdatemcp.hf.space/sse"
|
| 46 |
+
}
|
| 47 |
+
}
|
| 48 |
+
}
|
| 49 |
+
```
|
| 50 |
+
|
| 51 |
+
### 2. Restart Claude Desktop
|
| 52 |
+
|
| 53 |
+
### 3. Start Using!
|
| 54 |
+
|
| 55 |
+
"Search for Microsoft and show me their latest financial data" β¨
|
| 56 |
+
|
| 57 |
+
## π οΈ Available Tools (7)
|
| 58 |
+
|
| 59 |
+
| Tool | Description |
|
| 60 |
+
|------|-------------|
|
| 61 |
+
| `search_company` | Search by company name |
|
| 62 |
+
| `get_company_info` | Get detailed company info |
|
| 63 |
+
| `get_company_filings` | List SEC filings (10-K, 10-Q, 20-F) |
|
| 64 |
+
| `get_financial_data` | Get data for specific period |
|
| 65 |
+
| `extract_financial_metrics` β | Multi-year comprehensive metrics |
|
| 66 |
+
| `get_latest_financial_data` | Most recent data available |
|
| 67 |
+
| `advanced_search_company` | Smart search (name/ticker/CIK) |
|
| 68 |
+
|
| 69 |
+
## π¬ Usage Examples
|
| 70 |
+
|
| 71 |
+
**Quick Lookup**:
|
| 72 |
+
"Search for Tesla and show me their latest financial data"
|
| 73 |
+
|
| 74 |
+
**Trend Analysis**:
|
| 75 |
+
"Extract 5 years of financial metrics for Apple and analyze revenue growth"
|
| 76 |
+
|
| 77 |
+
**Company Comparison**:
|
| 78 |
+
"Compare NVIDIA and AMD revenue for the past 3 years"
|
| 79 |
+
|
| 80 |
+
**Output Format**:
|
| 81 |
+
```
|
| 82 |
+
π° Financial Data for 2024Q3:
|
| 83 |
+
{
|
| 84 |
+
"period": "2024Q3",
|
| 85 |
+
"revenue": "$65.59B",
|
| 86 |
+
"net_income": "$24.67B",
|
| 87 |
+
"eps": "$3.30"
|
| 88 |
+
}
|
| 89 |
+
```
|
| 90 |
+
|
| 91 |
+
## βοΈ Technical Stack
|
| 92 |
+
|
| 93 |
+
**Protocol**: Model Context Protocol 2024-11-05
|
| 94 |
+
**Transport**: Server-Sent Events (SSE)
|
| 95 |
+
**Framework**: FastAPI with Uvicorn
|
| 96 |
+
**Platform**: Hugging Face Spaces
|
| 97 |
+
**Data Source**: SEC EDGAR API
|
| 98 |
+
|
| 99 |
+
## π Compliance
|
| 100 |
+
|
| 101 |
+
**SEC User-Agent** (Required by SEC EDGAR API):
|
| 102 |
+
Juntao Peng Financial Report Metrics App (jtyxabc@gmail.com)
|
| 103 |
+
|
| 104 |
+
**Rate Limiting**: Follows SEC guidelines (10 requests/second max)
|
| 105 |
+
|
| 106 |
+
## ποΈ Infrastructure
|
| 107 |
+
|
| 108 |
+
- **Platform**: Hugging Face Spaces (CPU Upgrade, Always-On)
|
| 109 |
+
- **Uptime**: 99.9% availability
|
| 110 |
+
- **Response**: <200ms cached, 1-3s fresh data
|
| 111 |
+
- **Concurrency**: Up to 200 concurrent requests
|
| 112 |
+
- **Health Check**: Every 30 seconds
|
| 113 |
+
|
| 114 |
+
## π Documentation
|
| 115 |
+
|
| 116 |
+
- **[Usage Guide](./USAGE.md)** - Complete usage instructions
|
| 117 |
+
- **[Test Script](./test_mcp_sse.py)** - Test all endpoints
|
| 118 |
+
|
| 119 |
+
## π§ Local Development
|
| 120 |
+
|
| 121 |
+
```bash
|
| 122 |
+
# Start server
|
| 123 |
+
python mcp_server_sse.py
|
| 124 |
+
|
| 125 |
+
# Run tests
|
| 126 |
+
python test_mcp_sse.py
|
| 127 |
+
```
|