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
{{ message }}
Repository navigation
Commit 3d2c8ec
Browse filesBrowse the repository at this point in the historyBrowse files
FileCodeBox provides a **Model Context Protocol (MCP)** endpoint over Streamable HTTP. Compatible AI clients can create text or file shares through it.
For a local instance, use `http://localhost:12345/mcp`. If the administrator disables guest uploads or enables MCP token validation in the admin settings, configure `Authorization: Bearer <admin token>` in the client. Never commit the token to public configuration or source code.
14
+
15
+
## Available tools
16
+
17
+
-`share_text`: create a text share. Required: `text`; optional: `expire_value`, `expire_style`.
18
+
-`share_file`: upload a Base64-encoded file and create a share. Required: `filename`, `content_base64`; optional: `content_type`, `expire_value`, `expire_style`.
19
+
20
+
`expire_style` accepts `day`, `hour`, `minute`, `forever`, or `count`; `expire_value` must be greater than zero. Successful calls return a share code, URL, and Markdown link.
21
+
22
+
## Security and limits
23
+
24
+
MCP uploads follow FileCodeBox's guest-upload switch, admin-token validation, upload-size and file-type limits, and upload rate limits. Expose the endpoint only to trusted AI clients. Use HTTPS for public deployments and keep the admin token secure.
Copy file name to clipboardExpand all lines: readme_en.md
+5-20Lines changed: 5 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,6 +36,11 @@ docker run -d --restart unless-stopped \
36
36
```
37
37
38
38
Open `http://localhost:12345` and complete first-run setup. Pin a version in production; `latest` tracks the newest stable release.
39
+
## MCP for AI clients
40
+
41
+
FileCodeBox supports **MCP over Streamable HTTP**, allowing compatible AI clients to create text and file shares. Use `http://<your-server>:12345/mcp` (or `http://localhost:12345/mcp` for a local instance). No token is required by default. The available tools are `share_text` and `share_file`. If guest uploads are disabled or MCP token validation is enabled, configure `Authorization: Bearer <admin token>` in the client.
42
+
43
+
See the [MCP integration guide](https://fcb-docs.aiuo.net/en/guide/mcp).
39
44
40
45
## Simple, yet capable
41
46
@@ -78,26 +83,6 @@ Open `http://localhost:12345` and complete first-run setup. Pin a version in pro
78
83
-[API reference](https://fcb-docs.aiuo.net/en/api/) · upload, retrieval, and administration
79
84
-[Frontend source](https://github.com/vastsa/FileCodeBoxFronted) · the active 2024 theme
80
85
81
-
## Related projects
82
-
83
-
If you enjoy self-hosted “box” tools, also check out this project from the same author:
84
-
85
-
### [BokeBox](https://github.com/vastsa/BokeBox/) · Private AI Podcast Box
86
-
87
-
Drop in videos, links, or drafts, and get listen-worthy personal podcasts with custom host persona and voice.
0 commit comments