Metadata-Version: 2.4
Name: realtimex-docs-server
Version: 0.1.3.dev3
Summary: MCP server that exposes local documentation to agents
Author: RealTimeX
License-Expression: MIT
License-File: LICENSE
Keywords: automation,documentation,fastmcp,mcp
Requires-Python: >=3.10
Requires-Dist: fastmcp>=2.13.0.2
Requires-Dist: pydantic>=2.12.4
Description-Content-Type: text/markdown

# 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`/`limit` line 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
```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. `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
```bash
# Install dependencies
uv sync

# Run style or test tooling as needed
uv run ruff check
uv run pytest
```
