You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update README to clarify JSON configuration structure and MCP server examples
- Revised the section on `config.json` to emphasize that it must be standard JSON and provided a clearer example with comments for documentation purposes.
- Added detailed explanations for MCP server entries, including two examples for stdio commands.
- Removed outdated example section and streamlined the guidance for users setting up their configuration file.
Copy file name to clipboardExpand all lines: README.md
+40-42Lines changed: 40 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,26 +51,31 @@ OpenFox reads a single JSON file at **`~/.openfox/config.json`**. Fields map to
51
51
52
52
**Valid on-disk JSON**: `~/.openfox/config.json` must be **standard JSON** (double quotes, no `//` comments). The **`jsonc`** snippet below is **documentation only**—remove comments before saving, or paste the object into the Web **Config** editor.
53
53
54
-
### Reference `config.json` (valid JSON; structure matches a full on-disk file)
54
+
### Full reference example (JSONC; documentation only)
55
55
56
-
Secret values below are **placeholders**—use your own keys and never commit them to git.
56
+
The **key order, nesting, and non-secret values** match a full on-disk layout; secrets are **placeholders**. On disk the file must be **plain JSON** (no `//` comments).
57
57
58
-
```json
58
+
```jsonc
59
59
{
60
+
// Agent identity
60
61
"agent_id":"OpenFox",
61
62
"docs_enabled":true,
62
63
"os_security_key":"<os_security_key>",
64
+
// Browser / API origins (update if you change the listen port)
63
65
"cors_origin_list": [
64
66
"http://127.0.0.1:7777",
65
67
"http://localhost:7777"
66
68
],
67
69
"time_zone":"Asia/Shanghai",
70
+
// Enable RAG / knowledge search
68
71
"search_knowledge":true,
72
+
// Main chat model (LiteLLM)
69
73
"llm": {
70
74
"model_name":"deepseek/deepseek-chat",
71
75
"api_base":"https://api.deepseek.com",
72
76
"api_key":"<llm_api_key>"
73
77
},
78
+
// Channel integrations (example: Feishu)
74
79
"channels": {
75
80
"feishu": {
76
81
"app_id":"<feishu_app_id>",
@@ -79,7 +84,36 @@ Secret values below are **placeholders**—use your own keys and never commit th
@@ -113,6 +147,7 @@ Secret values below are **placeholders**—use your own keys and never commit th
113
147
"max_results":10,
114
148
"isolate_vector_search":false
115
149
},
150
+
// Toolkit toggles and options
116
151
"tools": {
117
152
"mcp": {
118
153
"include_tools":null,
@@ -224,44 +259,7 @@ Secret values below are **placeholders**—use your own keys and never commit th
224
259
}
225
260
```
226
261
227
-
To attach MCP servers, replace `"mcps": []` with a real array (see the **JSONC** example in the next subsection; strip comments for a valid file).
228
-
229
-
### MCP servers (`mcps`) — example with comments (JSONC, not valid for copy-paste as-is)
230
-
231
-
Each item is either **stdio** (`command` + `args`, optional `env`) or **HTTP** (`url`, optional `headers`). Below are two **stdio** examples: **uvx** (Python MCP from Git) and **npx** (Node MCP). For HTTP, set `url` (and optional `headers`) and leave `command` / `args` empty.
232
-
233
-
```jsonc
234
-
"mcps": [
235
-
{
236
-
// Display name
237
-
"name":"weibo",
238
-
// uvx: run tool from a Git dependency (--from) without a prior pip install
Requires **`uv` / `uvx`** and **Node.js `npx`** on the host where OpenFox runs, if you use those entries.
262
+
If you use the **stdio** MCP entries above, the host running OpenFox needs **`uv` / `uvx`** and **Node.js (with `npx`)** installed, as applicable.
265
263
266
264
You can edit the live file in the Web **Config** page or via the **expand/config** HTTP API when authenticated. After manual edits on disk, restart `python -m openfox` if the process is already running.
0 commit comments