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.1.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.1-py3-none-any.whl (2.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: your_docs_server-1.0.1.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.1.tar.gz
Algorithm Hash digest
SHA256 d65a2eb4ccadbd9ea1c4d11ef187aafdd7c029916e0ad5e1018524556837b7b4
MD5 4a4d530dbacb5db70fe2beda7d1ea53d
BLAKE2b-256 989a51d1c5e9d62ef047e8c1096d0a3fa85ef55f4873bbe340bbeec5e8db4e64

See more details on using hashes here.

Provenance

The following attestation bundles were made for your_docs_server-1.0.1.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.1-py3-none-any.whl.

File metadata

File hashes

Hashes for your_docs_server-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5bfec4c69897a2d89f29d7e687dc72683c3d231f075a123fc4cff5f1d33f4e0f
MD5 c0f0db961ea837e2296cfccde7072ab1
BLAKE2b-256 77c76145868f6df47102914fa56140abc8d71063a09caec9518c5b11ee677cf2

See more details on using hashes here.

Provenance

The following attestation bundles were made for your_docs_server-1.0.1-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