# realtimex-docs-server
A FastMCP-based MCP server that makes local documentation available to RealTimeX agents.
## Features
- Serve documentation from a configurable directory via CLI flag or environment variable
- List available documentation files using optional glob patterns
- Read documents as UTF-8 text with optional `offset`/`limit` line slicing
- Transport over stdio for MCP clients
## Configuration
Set the documentation root via the `--docs-path` CLI option or the `REALTIMEX_DOCS_ROOT` environment variable (CLI flag takes precedence).
## Usage
```bash
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. Provide `patterns` to `list_documents` for glob filtering when needed; omit it to list every document. `read_document` accepts `offset` and `limit` parameters to fetch a window of lines and returns plain UTF-8 content without added numbering.
## Development
```bash
# Install dependencies
uv sync
# Run style or test tooling as needed
uv run ruff check
uv run pytest
```
Raw data
{
"_id": null,
"home_page": null,
"name": "realtimex-docs-server",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "automation, documentation, fastmcp, mcp",
"author": "RealTimeX",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b6/7a/4262b2823c02d7f40f8e9e53474fea4f47df851a90f206bff38c1e024077/realtimex_docs_server-0.1.1.tar.gz",
"platform": null,
"description": "# realtimex-docs-server\n\nA FastMCP-based MCP server that makes local documentation available to RealTimeX agents.\n\n## Features\n- Serve documentation from a configurable directory via CLI flag or environment variable\n- List available documentation files using optional glob patterns\n- Read documents as UTF-8 text with optional `offset`/`limit` line slicing\n- Transport over stdio for MCP clients\n\n## Configuration\nSet the documentation root via the `--docs-path` CLI option or the `REALTIMEX_DOCS_ROOT` environment variable (CLI flag takes precedence).\n\n## Usage\n```bash\nuvx realtimex-docs-server --docs-path /path/to/docs\n```\n\nOnce connected, agents can call the `list_documents` and `read_document` tools to explore the configured directory. Provide `patterns` to `list_documents` for glob filtering when needed; omit it to list every document. `read_document` accepts `offset` and `limit` parameters to fetch a window of lines and returns plain UTF-8 content without added numbering.\n\n## Development\n```bash\n# Install dependencies\nuv sync\n\n# Run style or test tooling as needed\nuv run ruff check\nuv run pytest\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "MCP server that exposes local documentation to agents",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [
"automation",
" documentation",
" fastmcp",
" mcp"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7a1b1515c9b1d1827917c9afb18e087d726e3d03d5a682f81d38e1075c24e223",
"md5": "95751344f41df13c079ee9625c057095",
"sha256": "7d3f4f89dd2bdcc6c10b95f22b6d620de8609ff686a2dce4c42cd18bf0de1786"
},
"downloads": -1,
"filename": "realtimex_docs_server-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "95751344f41df13c079ee9625c057095",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 5241,
"upload_time": "2025-11-06T04:43:43",
"upload_time_iso_8601": "2025-11-06T04:43:43.830748Z",
"url": "https://files.pythonhosted.org/packages/7a/1b/1515c9b1d1827917c9afb18e087d726e3d03d5a682f81d38e1075c24e223/realtimex_docs_server-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b67a4262b2823c02d7f40f8e9e53474fea4f47df851a90f206bff38c1e024077",
"md5": "efaed0423da40366d4761aa1ca7241df",
"sha256": "af0a96fd657432b9dddad4cd5420b36fcffd1681a042b419c95a695a977ce877"
},
"downloads": -1,
"filename": "realtimex_docs_server-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "efaed0423da40366d4761aa1ca7241df",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 86553,
"upload_time": "2025-11-06T04:43:45",
"upload_time_iso_8601": "2025-11-06T04:43:45.703737Z",
"url": "https://files.pythonhosted.org/packages/b6/7a/4262b2823c02d7f40f8e9e53474fea4f47df851a90f206bff38c1e024077/realtimex_docs_server-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-11-06 04:43:45",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "realtimex-docs-server"
}
JSON