Skip to main content

Full-featured documentation server with MCP, web UI, and REST API — convenience install for your-docs-mcp

Project description

your-docs-server

Full-featured documentation server with MCP protocol support, server-rendered web UI, and REST API.

This is a convenience meta-package that installs your-docs-mcp with the [server] extras (MCP + web server + OpenAPI support).

Installation

pip install your-docs-server

This is equivalent to:

pip install "your-docs-mcp[server]"

Quick Start

# Point to your markdown documentation
export DOCS_ROOT=/path/to/your/docs

# Start the server (MCP + Web UI)
your-docs-server

The web UI is available at http://127.0.0.1:8123/docs/ with:

  • Server-rendered documentation pages with full SEO support
  • Search with keyword + semantic matching
  • Dark/light theme toggle
  • Mobile-responsive layout
  • REST API at /api/*
  • MCP protocol via SSE at /sse

Other Install Flavors

Command What you get
pip install your-docs-mcp MCP server only (for Claude Desktop, VS Code)
pip install your-docs-server Full server (MCP + Web UI + REST API)
pip install "your-docs-mcp[full]" Everything (+ vector search + PDF generation)

For full documentation, configuration, and API reference, see the main project repository.

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

your_docs_server-1.0.2.tar.gz (2.1 kB view details)

Uploaded Source

Built Distribution

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

your_docs_server-1.0.2-py3-none-any.whl (2.2 kB view details)

Uploaded Python 3

File details

Details for the file your_docs_server-1.0.2.tar.gz.

File metadata

  • Download URL: your_docs_server-1.0.2.tar.gz
  • Upload date:
  • Size: 2.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for your_docs_server-1.0.2.tar.gz
Algorithm Hash digest
SHA256 feac07dc95adacdb6e22fa2c43a519e5504b2577d2c76c8f3b7c072d9c4a3c30
MD5 ab50af45fbd240a48a0f7c1af44134cf
BLAKE2b-256 3c2dc76c66553e6bddc2c45333654269b140f3c72ec387c1cb2fd2b02ac7d918

See more details on using hashes here.

Provenance

The following attestation bundles were made for your_docs_server-1.0.2.tar.gz:

Publisher: release.yml on esola-thomas/your-docs-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file your_docs_server-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for your_docs_server-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 790a473c0337ccbbc59a6e30bc2d8a58aa2c7475fc0a798dbd3134bdbd2d39ca
MD5 3ba4b457e8ab36a6421bc97cd629c942
BLAKE2b-256 9b914cbadd16a631d80e50c5ed7ae6a881798b6a96758f41475ec8c66e2f081d

See more details on using hashes here.

Provenance

The following attestation bundles were made for your_docs_server-1.0.2-py3-none-any.whl:

Publisher: release.yml on esola-thomas/your-docs-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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