Skip to main content

MCP server that exposes local documentation to agents

Project description

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 every documentation file in a single call
  • 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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

realtimex_docs_server-0.1.2.tar.gz (182.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

realtimex_docs_server-0.1.2-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file realtimex_docs_server-0.1.2.tar.gz.

File metadata

File hashes

Hashes for realtimex_docs_server-0.1.2.tar.gz
Algorithm Hash digest
SHA256 82224a932e2d1dddf7e166327265a0c0fb9ff77bb98b3792ab408e9385734d1f
MD5 5f4a88b171bcdaf60523e8394e1d12dc
BLAKE2b-256 88f511ea919fa983d33a356f86e040de931572572cc599a56d95476373299962

See more details on using hashes here.

File details

Details for the file realtimex_docs_server-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for realtimex_docs_server-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e39562aa50519d0bbf8264ab37354113358ee463955fb6f3d5dd493a57e2a82e
MD5 ebaed1779b22f04c53ec7f064b48b604
BLAKE2b-256 702ef1781d5ec8833ac4a557203c5053b352b5cea99a431e5e6b6a556f77b3e8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page