krx-cli 1.2.0 → 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +74 -0
- package/SKILL.md +1 -1
- package/dist/mcp.js +31066 -0
- package/dist/mcp.js.map +7 -0
- package/package.json +4 -2
package/README.md
CHANGED
|
@@ -224,6 +224,80 @@ mkdir -p ~/.claude/skills && cp SKILL.md ~/.claude/skills/krx-cli.md
|
|
|
224
224
|
mkdir -p ~/.cursor/skills && cp SKILL.md ~/.cursor/skills/krx-cli.md
|
|
225
225
|
```
|
|
226
226
|
|
|
227
|
+
## MCP 서버 (Claude Desktop / ChatGPT Desktop)
|
|
228
|
+
|
|
229
|
+
CLI 외에 MCP(Model Context Protocol) 서버도 제공합니다. Claude Desktop, ChatGPT Desktop 등 MCP를 지원하는 클라이언트에서 사용할 수 있습니다.
|
|
230
|
+
|
|
231
|
+
### 설정 (Claude Desktop)
|
|
232
|
+
|
|
233
|
+
API 키는 `krx auth set <key>`로 등록한 것이 자동으로 사용됩니다.
|
|
234
|
+
`krx-mcp`는 `npm install -g krx-cli`로 설치하면 함께 설치됩니다.
|
|
235
|
+
|
|
236
|
+
### Claude Desktop
|
|
237
|
+
|
|
238
|
+
설정 파일 위치:
|
|
239
|
+
|
|
240
|
+
- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
241
|
+
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
|
|
242
|
+
|
|
243
|
+
```json
|
|
244
|
+
{
|
|
245
|
+
"mcpServers": {
|
|
246
|
+
"krx": {
|
|
247
|
+
"command": "krx-mcp"
|
|
248
|
+
}
|
|
249
|
+
}
|
|
250
|
+
}
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
### ChatGPT Desktop
|
|
254
|
+
|
|
255
|
+
설정 파일 위치:
|
|
256
|
+
|
|
257
|
+
- **macOS**: `~/Library/Application Support/com.openai.chat/mcp.json`
|
|
258
|
+
- **Windows**: `%LOCALAPPDATA%\OpenAI\ChatGPT\mcp.json`
|
|
259
|
+
|
|
260
|
+
```json
|
|
261
|
+
{
|
|
262
|
+
"mcpServers": {
|
|
263
|
+
"krx": {
|
|
264
|
+
"command": "krx-mcp"
|
|
265
|
+
}
|
|
266
|
+
}
|
|
267
|
+
}
|
|
268
|
+
```
|
|
269
|
+
|
|
270
|
+
설정 후 앱을 재시작하면 MCP 도구가 활성화됩니다.
|
|
271
|
+
|
|
272
|
+
### 제공 Tool
|
|
273
|
+
|
|
274
|
+
| Tool | 설명 |
|
|
275
|
+
| ---------------- | ------------------------------------------ |
|
|
276
|
+
| `krx_index` | 지수 일별시세 (KOSPI/KOSDAQ/KRX/채권/파생) |
|
|
277
|
+
| `krx_stock` | 주식 일별매매정보 + 종목 기본정보 |
|
|
278
|
+
| `krx_etp` | ETF/ETN/ELW 일별매매정보 |
|
|
279
|
+
| `krx_bond` | 채권 일별매매정보 (국채/일반/소액) |
|
|
280
|
+
| `krx_derivative` | 선물/옵션 일별매매정보 |
|
|
281
|
+
| `krx_commodity` | 금/석유/배출권 일별매매정보 |
|
|
282
|
+
| `krx_esg` | ESG 지수/채권/ETP 정보 |
|
|
283
|
+
| `krx_schema` | 엔드포인트 응답 필드 스키마 조회 |
|
|
284
|
+
| `krx_rate_limit` | 일일 API 호출 현황 조회 |
|
|
285
|
+
|
|
286
|
+
### 사용 예시
|
|
287
|
+
|
|
288
|
+
MCP 클라이언트에서 자연어로 요청하면 됩니다:
|
|
289
|
+
|
|
290
|
+
```
|
|
291
|
+
"오늘 코스피 지수 보여줘"
|
|
292
|
+
→ krx_index tool 호출 (endpoint: "kospi_dd_trd")
|
|
293
|
+
|
|
294
|
+
"삼성전자 주가 알려줘"
|
|
295
|
+
→ krx_stock tool 호출 (endpoint: "stk_bydd_trd", fields: ["ISU_NM", "TDD_CLSPRC", "FLUC_RT"])
|
|
296
|
+
|
|
297
|
+
"오늘 API 몇 번 호출했어?"
|
|
298
|
+
→ krx_rate_limit tool 호출
|
|
299
|
+
```
|
|
300
|
+
|
|
227
301
|
## 개발
|
|
228
302
|
|
|
229
303
|
```bash
|
package/SKILL.md
CHANGED