A tool for discovering, crawl, and indexing web sites to be exposed as an MCP server for LLM agents for better and more up-to-date reasoning and code generation.
Doctor provides a complete stack for:
- Crawling web pages using crawl4ai
- Chunking text with LangChain
- Creating embeddings with OpenAI via litellm
- Storing data in DuckDB with vector search support
- Exposing search functionality via a FastAPI web service
- Making these capabilities available to LLMs through an MCP server
- Database for storing document data and embeddings with vector search capabilities
- Managed by unified Database class
- Message broker for asynchronous task processing
- Processes crawl jobs
- Chunks text
- Creates embeddings
- FastAPI service exposing endpoints
- Fetching, searching, and viewing data
- Exposing the MCP server
- Docker and Docker Compose
- Python 3.10+
- uv (Python package manager)
- OpenAI API key
- Clone this repository
- Set up environment variables:
export OPENAI_API_KEY=your-openai-key
- Run the stack:
docker compose up
- Go to http://localhost:9111/docs to see the OpenAPI docs
- Look for the
/fetch_url
endpoint and start a crawl job by providing a URL - Use
/job_progress
to see the current job status - Configure your editor to use
http://localhost:9111/mcp
as an MCP server
POST /fetch_url
: Start crawling a URLGET /search_docs
: Search indexed documentsGET /job_progress
: Check crawl job progressGET /list_doc_pages
: List indexed pagesGET /get_doc_page
: Get full text of a page
Ensure that your Docker Compose stack is up, and then add to your Cursor or VSCode MCP Servers configuration:
"doctor": {
"type": "sse",
"url": "http://localhost:9111/mcp"
}
To run all tests:
<
86DE
span class="pl-c"># Run all tests with coverage report
pytest
To run specific test categories:
# Run only unit tests
pytest -m unit
# Run only async tests
pytest -m async_test
# Run tests for a specific component
pytest tests/lib/test_crawler.py
The project is configured to generate coverage reports automatically:
# Run tests with detailed coverage report
pytest --cov=src --cov-report=term-missing
tests/conftest.py
: Common fixtures for all teststests/lib/
: Tests for library componentstest_crawler.py
: Tests for the crawler moduletest_chunker.py
: Tests for the chunker moduletest_embedder.py
: Tests for the embedder moduletest_database.py
: Tests for the unified Database class
tests/common/
: Tests for common modulestests/services/
: Tests for service layertests/api/
: Tests for API endpoints
The project is configured with pre-commit hooks that run automatically before each commit:
ruff check --fix
: Lints code and automatically fixes issuesruff format
: Formats code according to project style- Trailing whitespace removal
- End-of-file fixing
- YAML validation
- Large file checks
To set up pre-commit hooks:
# Install pre-commit
uv pip install pre-commit
# Install the git hooks
pre-commit install
You can run the pre-commit hooks manually on all files:
# Run all pre-commit hooks
pre-commit run --all-files
Or on staged files only:
# Run on staged files
pre-commit run
This project is licensed under the MIT License - see the LICENSE.md file for details.