Metadata-Version: 2.4
Name: neo-docs-mcp
Version: 0.1.1
Summary: MCP server to search the NEO docs (docs.neo.crowdar.com) from an AI assistant.
Author: Crowdar
License-Expression: MIT
Project-URL: Homepage, https://docs.neo.crowdar.com
Project-URL: Documentation, https://docs.neo.crowdar.com/MCP/docs-neo/
Keywords: mcp,model-context-protocol,documentation,search,neo,crowdar
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Text Processing :: Indexing
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mcp<3,>=2.3
Requires-Dist: snowballstemmer>=2.2
Requires-Dist: numpy>=1.26
Requires-Dist: fastembed>=0.9
Provides-Extra: build
Requires-Dist: pyyaml>=6.0; extra == "build"
Requires-Dist: markdown>=3.6; extra == "build"
Requires-Dist: pymdown-extensions>=10.0; extra == "build"
Provides-Extra: semantic
Provides-Extra: dev
Requires-Dist: pytest>=8.0; extra == "dev"
Requires-Dist: neo-docs-mcp[build]; extra == "dev"
Dynamic: license-file

# neo-docs-mcp

MCP server that lets an AI assistant search the NEO docs (`docs.neo.crowdar.com`) while it works.

It runs **locally** (stdio), like the other MCP servers NEO uses. The search index is **not**
shipped in the package: the site build publishes it as a static file
(`https://docs.neo.crowdar.com/neo-docs-index.json`), and the server downloads it at startup and
caches it. Publishing the docs updates what the server answers, with no new package release.

## Use

```json
{ "mcpServers": { "neo-docs": { "command": "uvx", "args": ["neo-docs-mcp"] } } }
```

Tools: `search_docs`, `get_section`, `get_page`, `list_toc`. Each one takes `lang` (`es` by default, or `en`).

**Search.** Every query runs BM25 and semantic search (`multilingual-e5-small`) and fuses them
(Reciprocal Rank Fusion). The model (~470 MB) is downloaded on the first run, in the background:
until it's loaded the server answers with BM25, then switches to hybrid on its own. `--mode bm25`
skips the model, for networks where it can't be downloaded.

The package is on PyPI: `uvx` downloads it on first use, no install step. You only need
[uv](https://docs.astral.sh/uv/getting-started/installation/).

| Option | Environment | Default |
|---|---|---|
| `--index` | `NEO_DOCS_INDEX` | The published index (path or URL) |
| `--lang` | `NEO_DOCS_LANG` | `es` |
| `--mode` | `NEO_DOCS_SEARCH_MODE` | `hybrid` (BM25 until the model is loaded; `bm25` skips the model) |
| `--cache-dir` | `NEO_DOCS_CACHE_DIR` | `~/.cache/neo-docs-mcp` (`%LOCALAPPDATA%\neo-docs-mcp` on Windows) |
| `--http` | — | stdio; `--http` serves Streamable HTTP on `/mcp` |
| — | `NEO_DOCS_MODEL_CACHE` | `<cache-dir>/models` (where the semantic model is stored) |

## More

- NEO docs: <https://docs.neo.crowdar.com>
- License: MIT. It covers the server code; the documentation it searches belongs to Crowdar.
