realtimex-docs-server
A FastMCP-based MCP server that makes local documentation available to RealTimeX agents.
Features
- Serve documentation from bundled workflow files by default, or from a custom directory via CLI/env override
- List every documentation file with a single call
- Read documents as UTF-8 text with optional
offset/limitline slicing - Transport over stdio for MCP clients
Configuration
By default, the server loads the workflow docs bundled with the package. To override, set the documentation root via the --docs-path CLI option or the REALTIMEX_DOCS_ROOT environment variable (CLI flag takes precedence).
Usage
uvx realtimex-docs-server --docs-path /path/to/docs
Once connected, agents can call the list_documents and read_document tools to explore the configured directory. list_documents returns the full file inventory, while read_document accepts offset and limit parameters to fetch a window of lines and returns plain UTF-8 content without added numbering.
Development
# Install dependencies
uv sync
# Run style or test tooling as needed
uv run ruff check
uv run pytest
1 maintainer
Metadata
1 maintainer
Release files for realtimex-docs-server 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| realtimex_docs_server-0.1.3.tar.gz | 105.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| realtimex_docs_server-0.1.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 115.9 kB
Release files / realtimex_docs_server-0.1.3.tar.gz
| Download URL | realtimex_docs_server-0.1.3.tar.gz |
|---|---|
| Size | 105.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5a33fc91bbe90c32882c6293e09c205fa0e78ad22e6de9a2a3b3e3037927abdd
|
|
BLAKE2b-256 checksum How to use checksums |
b79f0fc7e5b98d4ed6c48f4694a05e8b8342c10a64f3c900f2e74abbe59b2f84
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.7.16
|
Release files / realtimex_docs_server-0.1.3-py3-none-any.whl
| Download URL | realtimex_docs_server-0.1.3-py3-none-any.whl |
|---|---|
| Size | 10.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ca5020319e3c2db1d1cbf7d24341fb8ca4c92f21b2bc963b0914ae6c5831db20
|
|
BLAKE2b-256 checksum How to use checksums |
df0a17c3971d95306449e37e54a16fce7f0c83db922bb34f43ef2e4b6ae7769e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.7.16
|
