JC321 commited on
Commit
202f33c
·
verified ·
1 Parent(s): b1bccee

Delete CLIENT_CONFIG_GUIDE.md

Browse files
Files changed (1) hide show
  1. CLIENT_CONFIG_GUIDE.md +0 -292
CLIENT_CONFIG_GUIDE.md DELETED
@@ -1,292 +0,0 @@
1
- # 瀹㈡埛绔�厤缃�寚鍗?- SEC Financial Data MCP Server
2
-
3
- ## 馃敆 鏈嶅姟鍣ㄤ俊�?
4
-
5
- **HF Space URL**: `https://jc321-easyreportdatamcp.hf.space`
6
- **浼犺緭鍗忚�**: HTTP (JSON-RPC 2.0)
7
- **SDK 绫诲�?*: Gradio (涓嶆�?Docker)
8
-
9
- ---
10
-
11
- ## 馃摗 鍙�敤鐨?MCP 绔��?
12
-
13
- 褰撳墠鏈嶅姟鍣ㄦ彁渚涗互�?HTTP 绔�偣鐢ㄤ簬 MCP 瀹㈡埛绔�皟鐢��?
14
-
15
- ### 绔��?1: `/mcp`
16
- - **瀹屾�?URL**: `https://jc321-easyreportdatamcp.hf.space/mcp`
17
- - **鏂规�?*: POST, GET
18
- - **鍗忚�?*: JSON-RPC 2.0
19
-
20
- ### 绔��?2: `/sse`
21
- - **瀹屾�?URL**: `https://jc321-easyreportdatamcp.hf.space/sse`
22
- - **鏂规�?*: POST, GET
23
- - **鍗忚�?*: JSON-RPC 2.0
24
-
25
- **娉ㄦ�?*: 涓や釜绔�偣鍔熻兘瀹屽叏鐩稿悓锛屼负浜嗗悜鍚庡吋瀹逛繚鐣欎簡涓や釜璺�緞銆?
26
-
27
- ---
28
-
29
- ## 馃洜�?瀹㈡埛绔�厤缃�柟寮?
30
-
31
- ### 鏂瑰�?1: HTTP 浼犺緭锛堟帹鑽愮敤浜?HF Space�?
32
-
33
- ```json
34
- {
35
- "mcpServers": {
36
- "sec-financial-data": {
37
- "url": "https://jc321-easyreportdatamcp.hf.space/mcp",
38
- "transport": "http"
39
- }
40
- }
41
- }
42
- ```
43
-
44
- 鎴栬€呬娇鐢?`/sse` 绔�偣锛?
45
-
46
- ```json
47
- {
48
- "mcpServers": {
49
- "sec-financial-data": {
50
- "url": "https://jc321-easyreportdatamcp.hf.space/sse",
51
- "transport": "http"
52
- }
53
- }
54
- }
55
- ```
56
-
57
- ### 鏂瑰�?2: SSE 浼犺緭锛堝�鏋滃�鎴风�鏀�寔�?
58
-
59
- ```json
60
- {
61
- "mcpServers": {
62
- "sec-financial-data": {
63
- "url": "https://jc321-easyreportdatamcp.hf.space/sse",
64
- "transport": "sse"
65
- }
66
- }
67
- }
68
- ```
69
-
70
- ---
71
-
72
- ## 馃搵 鏀�寔�?JSON-RPC 鏂规�?
73
-
74
- ### 1. 鍒楀嚭鎵€鏈夊伐�?
75
- ```json
76
- {
77
- "jsonrpc": "2.0",
78
- "method": "tools/list",
79
- "id": 1
80
- }
81
- ```
82
-
83
- **鍝嶅簲绀轰緥**:
84
- ```json
85
- {
86
- "jsonrpc": "2.0",
87
- "id": 1,
88
- "result": {
89
- "tools": [
90
- {
91
- "name": "search_company",
92
- "description": "Search for a company by name in SEC EDGAR database.",
93
- "inputSchema": {...}
94
- },
95
- ...
96
- ]
97
- }
98
- }
99
- ```
100
-
101
- ### 2. 璋冪敤宸ュ叿
102
- ```json
103
- {
104
- "jsonrpc": "2.0",
105
- "method": "tools/call",
106
- "params": {
107
- "name": "search_company",
108
- "arguments": {
109
- "company_name": "Tesla"
110
- }
111
- },
112
- "id": 2
113
- }
114
- ```
115
-
116
- **鍝嶅簲绀轰緥**:
117
- ```json
118
- {
119
- "jsonrpc": "2.0",
120
- "id": 2,
121
- "result": {
122
- "content": [
123
- {
124
- "type": "text",
125
- "text": "{\"cik\":\"0001318605\",\"name\":\"Tesla, Inc.\",\"ticker\":\"TSLA\"}"
126
- }
127
- ]
128
- }
129
- }
130
- ```
131
-
132
- ---
133
-
134
- ## 馃敡 鍙�敤鐨?7 涓�伐鍏?
135
-
136
- | 宸ュ叿鍚嶇�?| 鍙傛�?| 璇存�?|
137
- |---------|------|------|
138
- | `search_company` | `company_name: str` | 鎸夊叕鍙稿悕绉版悳绱?|
139
- | `get_company_info` | `cik: str` | 鑾峰彇鍏�徃璇︾粏淇℃伅 |
140
- | `get_company_filings` | `cik: str`, `form_types?: list[str]` | 鑾峰�?SEC 鏂囦欢鍒楄�?|
141
- | `get_financial_data` | `cik: str`, `period: str` | 鑾峰彇鐗瑰畾鏈熼棿璐㈠姟鏁版�?|
142
- | `extract_financial_metrics` | `cik: str`, `years?: int` (榛樿�?) | 鎻愬彇澶氬勾璐㈠姟鎸囨爣 |
143
- | `get_latest_financial_data` | `cik: str` | 鑾峰彇鏈€鏂拌储鍔℃暟鎹?|
144
- | `advanced_search_company` | `company_input: str` | 楂樼骇鎼滅储锛堟敮鎸佸叕鍙稿�?CIK�?|
145
-
146
- ---
147
-
148
- ## 馃�?娴嬭瘯绔�偣
149
-
150
- ### 浣跨�?curl 娴嬭瘯锛?
151
-
152
- ```bash
153
- # 娴嬭瘯绔�偣鏄�惁鍙�敤
154
- curl https://jc321-easyreportdatamcp.hf.space/mcp
155
-
156
- # 鍒楀嚭宸ュ叿
157
- curl -X POST https://jc321-easyreportdatamcp.hf.space/mcp \
158
- -H "Content-Type: application/json" \
159
- -d '{"jsonrpc":"2.0","method":"tools/list","id":1}'
160
-
161
- # 璋冪敤宸ュ叿
162
- curl -X POST https://jc321-easyreportdatamcp.hf.space/mcp \
163
- -H "Content-Type: application/json" \
164
- -d '{
165
- "jsonrpc":"2.0",
166
- "method":"tools/call",
167
- "params":{
168
- "name":"search_company",
169
- "arguments":{"company_name":"Tesla"}
170
- },
171
- "id":2
172
- }'
173
- ```
174
-
175
- ---
176
-
177
- ## 鈿狅�?閲嶈�璇存槑
178
-
179
- ### 1. **涓嶆�?stdio 妯″紡**
180
- 褰撳墠鏈嶅姟鍣ㄩ儴缃插湪 HF Space 涓婏�?*涓嶆敮鎸?stdio 浼犺�?*锛屽彧鏀�寔 HTTP/SSE�?
181
-
182
- �?**涓嶈�浣跨敤**:
183
- ```json
184
- {
185
- "command": "python",
186
- "args": ["path/to/mcp_server.py"]
187
- }
188
- ```
189
-
190
- �?**搴旇�浣跨敤**:
191
- ```json
192
- {
193
- "url": "https://jc321-easyreportdatamcp.hf.space/mcp",
194
- "transport": "http"
195
- }
196
- ```
197
-
198
- ### 2. **Gradio SDK 闄愬�?*
199
- - 鏈嶅姟鍣ㄤ娇�?Gradio SDK 杩愯�?
200
- - MCP 绔�偣閫氳繃 FastAPI 鎸傝浇鍦?Gradio 涔嬩�?
201
- - 绔�偣璺�緞: `/mcp` �?`/sse` 锛堜袱鑰呯瓑鏁堬�?
202
-
203
- ### 3. **CIK 鏍煎�?*
204
- - CIK 闇€�?10 浣嶆暟瀛楁牸寮忥紝渚嬪�? `0001318605`
205
- - 鎼滅储鍏�徃鍚嶆椂浼氳嚜鍔ㄨ繑鍥炴�纭�牸寮忕殑 CIK
206
-
207
- ---
208
-
209
- ## 馃摓 璋冭瘯鎶€宸?
210
-
211
- ### 濡傛灉瀹㈡埛绔�姤 404 閿欒�锛?
212
-
213
- 1. **妫€�?URL 鏄�惁姝g�?*:
214
- - �?`https://jc321-easyreportdatamcp.hf.space/mcp`
215
- - �?`https://jc321-easyreportdatamcp.hf.space/sse`
216
- - �?`https://jc321-easyreportdatamcp.hf.space` (缂哄皯绔�偣璺��?
217
-
218
- 2. **妫€鏌ヤ紶杈撶被�?*:
219
- - 灏濊�?`"transport": "http"` 鑰屼笉鏄?`"transport": "sse"`
220
- - 鎴栬€呭皾璇?`"transport": "sse"`
221
-
222
- 3. **妫€鏌ュ�鎴风� MCP 鐗堟�?*:
223
- - 鏈嶅姟鍣ㄤ娇�?MCP 鍗忚�?2024-11-05 鐗堟�?
224
- - 纭�繚瀹㈡埛绔�敮�?JSON-RPC 2.0
225
-
226
- ### 濡傛灉宸ュ叿璋冪敤澶辫触�?
227
-
228
- 1. **妫€鏌ュ弬鏁版牸�?*:
229
- ```json
230
- {
231
- "params": {
232
- "name": "search_company",
233
- "arguments": {
234
- "company_name": "Tesla" // 娉ㄦ剰鍙傛暟鍚嶅繀椤诲畬鍏ㄥ尮�?
235
- }
236
- }
237
- }
238
- ```
239
-
240
- 2. **鏌ョ湅杩斿洖鐨勯敊璇�俊�?*:
241
- - 鏈嶅姟鍣ㄤ細杩斿洖璇︾粏鐨勯敊璇�弿�?
242
- - 妫€�?`result.content[0].text` 涓�殑閿欒�淇℃�?
243
-
244
- ---
245
-
246
- ## 馃幆 閰嶇疆妯℃澘锛堝�鍒跺嵆鐢��?
247
-
248
- ### Claude Desktop 閰嶇�?
249
-
250
- 浣嶇�? `%APPDATA%\Claude\claude_desktop_config.json` (Windows)
251
-
252
- ```json
253
- {
254
- "mcpServers": {
255
- "sec-financial-data": {
256
- "url": "https://jc321-easyreportdatamcp.hf.space/mcp",
257
- "transport": "http"
258
- }
259
- }
260
- }
261
- ```
262
-
263
- ### Cursor IDE 閰嶇�?
264
-
265
- �?MCP 璁剧疆涓�坊鍔狅�?
266
-
267
- ```json
268
- {
269
- "mcpServers": {
270
- "sec-financial-data": {
271
- "url": "https://jc321-easyreportdatamcp.hf.space/mcp",
272
- "transport": "http"
273
- }
274
- }
275
- }
276
- ```
277
-
278
- ---
279
-
280
- ## �?楠岃瘉娓呭崟
281
-
282
- - [ ] URL 鍖呭�?`/mcp` �?`/sse` 绔�偣璺�緞
283
- - [ ] 浣跨�?`"transport": "http"` �?`"transport": "sse"`
284
- - [ ] 涓嶈�浣跨敤 `"command"` �?`"args"` (閭f�?stdio 妯″紡)
285
- - [ ] 纭�繚瀹㈡埛绔�敮�?JSON-RPC 2.0
286
- - [ ] CIK 鍙傛暟浣跨敤 10 浣嶆暟瀛楁牸寮?
287
-
288
- ---
289
-
290
- **鏈€鍚庢洿鏂?*: 2025-11-29
291
- **鏈嶅姟鍣ㄧ増�?*: Gradio + FastAPI + FastMCP
292
- **鍗忚�?*: MCP 2024-11-05 (JSON-RPC 2.0)