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 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

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

# 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.0.tar.gz (86.4 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.0-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for realtimex_docs_server-0.1.0.tar.gz
Algorithm Hash digest
SHA256 64ddf27b10adf7729e3c56eac681622588b3207fc55dbd74e3f8d8ec67d487e8
MD5 65030323780be87b233e1ca7f9c66c15
BLAKE2b-256 973ee223152f3fcf945de77d63ee953686af82ee7f39a8a98bb79d4901fe0947

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for realtimex_docs_server-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bdea2ebd7ab64dd7c57205099134d503e17768be95fa5abb1d694d5a27beb90e
MD5 ee848f6e5fb88b0a84e2432520062837
BLAKE2b-256 9b35a928a1243ce6f4dfe0685a3c124026df7cc58d041c01855461a12f133c2e

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