Skip to content

Commit 9c00857

Browse files
linsamtwclaude
andcommitted
docs: add Codex CLI install guide
install/ 原本涵蓋 6 個 host 但缺 Codex。新增 install/codex.md(`codex mcp add` 一行指令 + `~/.codex/config.toml` 的 `[mcp_servers.finmind]` TOML 寫法,注意 Codex 的 env 是獨立子表)並在 README host 表格補一列 Codex CLI。 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent f0aeca0 commit 9c00857

2 files changed

Lines changed: 44 additions & 0 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ pipx install finmind-mcp
3030
| Cursor | [install/cursor.md](install/cursor.md) |
3131
| Windsurf | [install/windsurf.md](install/windsurf.md) |
3232
| Gemini CLI | [install/gemini-cli.md](install/gemini-cli.md) |
33+
| Codex CLI | [install/codex.md](install/codex.md) |
3334

3435
## 範例查詢
3536

install/codex.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Codex CLI
2+
3+
在 OpenAI Codex CLI 啟用 FinMind MCP server(本機 stdio 模式),讓你在終端機用自然語言查 FinMind 金融資料。
4+
5+
## 安裝套件
6+
7+
先裝 [uv](https://docs.astral.sh/uv/)(提供 `uvx`);`uvx` 會在啟動時從 PyPI 抓 `finmind-mcp`,不需另外安裝。
8+
9+
```bash
10+
# 或常駐安裝(下方 command 改成 finmind-mcp):
11+
pipx install finmind-mcp
12+
```
13+
14+
## 設定
15+
16+
一行指令(推薦):
17+
18+
```bash
19+
codex mcp add finmind --env FINMIND_TOKEN=your-token-here -- uvx finmind-mcp
20+
```
21+
22+
格式為 `codex mcp add <名稱> --env K=V -- <stdio 啟動指令>`
23+
24+
或手動編 `~/.codex/config.toml`(注意 Codex 的 `env`**獨立子表**,跟 Claude 的 JSON 不同):
25+
26+
```toml
27+
[mcp_servers.finmind]
28+
command = "uvx"
29+
args = ["finmind-mcp"]
30+
31+
[mcp_servers.finmind.env]
32+
FINMIND_TOKEN = "your-token-here"
33+
```
34+
35+
> 也可放專案層級 `.codex/config.toml`(僅限信任的專案)。
36+
37+
## 取得 Token
38+
39+
請先依 [token 取得指引](../knowledge/token-guide.md) 取得 FinMind Token,填入上方 `FINMIND_TOKEN`
40+
41+
## 驗證
42+
43+
在 Codex TUI 輸入 `/mcp` 查看 `finmind` 是否連線;接著問「列出 FinMind 可用的 dataset」應回傳清單。

0 commit comments

Comments
 (0)