MCP Documentation Search Server
A powerful documentation search server built with FastMCP, enabling AI systems to intelligently search across multiple popular framework and library documentations. This tool ensures that AI models can quickly access and retrieve relevant information from various documentation sources using a unified interface.
π Features
π Requirements
- Python 3.8+
- pip or uv package manager
- Virtual environment (recommended)
π Quick Start
- Clone the Repository
git clone <repository-url>
cd mcp-server
- Set Up Virtual Environment
python -m venv .venv
# On Windows:
.venv\Scripts\activate
# On Unix or MacOS:
source .venv/bin/activate
- Install Dependencies
pip install -r requirements.txt
- Run the Server
python main.py
π» Usage
Basic Usage
from main import get_docs
# Search Framer Motion documentation
result = await get_docs(
query="how to animate on scroll",
library="framer-motion"
)
# Search Next.js documentation
result = await get_docs(
query="how to use app router",
library="next"
)
Library Name Variations
The system intelligently handles various library name formats:
# All these calls will work the same way
await get_docs(query="animations", library="framer")
await get_docs(query="animations", library="framermotion")
await get_docs(query="animations", library="framer-motion")
await get_docs(query="animations", library="motion")
π§ͺ Testing
The project includes a comprehensive test suite to ensure reliability and correctness. Tests are organized into three main categories:
Test Structure
Running Tests
To run all tests:
python -m pytest
To run specific test modules:
python -m pytest tests/test_utils.py
python -m pytest tests/test_services.py
python -m pytest tests/test_main.py
To run tests with verbose output:
python -m pytest -v
Test Coverage
The tests cover:
- β
Library name normalization and validation
- β
URL retrieval for different libraries
- β
Web search functionality
- β
Content fetching and error handling
- β
Documentation search integration
- β
API input validation and error handling
- β
Alias resolution for different library name formats
Asynchronous Testing
The project uses a custom run_async
helper function to test asynchronous code in a synchronous test environment. This approach allows for testing async functions without requiring complex test setup.
ποΈ Project Structure
mcp-server/
βββ main.py # Entry point and FastMCP tool definition
βββ config.py # Configuration settings and constants
βββ services.py # Web search and content fetching services
βββ utils.py # Utility functions for library name handling
βββ tests/ # Test suite
β βββ test_utils.py # Tests for utility functions
β βββ test_services.py # Tests for web services
β βββ test_main.py # Tests for main API
β βββ conftest.py # Pytest configuration
βββ requirements.txt # Project dependencies
βββ README.md # Documentation
π§ Configuration
Supported Libraries
To add a new library:
- Add the documentation URL in
config.py
:
DOCS_URLS = {
"new-library": "https://docs.new-library.com",
# ... existing entries
}
- Add common aliases:
LIBRARY_ALIASES = {
"new-lib": "new-library",
# ... existing entries
}
HTTP Settings
Modify in config.py
:
HTTP_TIMEOUT = 30.0 # Timeout in seconds
MAX_SEARCH_RESULTS = 2 # Number of search results to fetch
π€ Contributing
We welcome contributions! Here's how you can help:
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests for new functionality
- Ensure all tests pass
- Submit a pull request
Adding New Libraries
- Update
DOCS_URLS
in config.py
- Add relevant aliases in
LIBRARY_ALIASES
- Test the integration
- Update documentation
- Submit a pull request
π Troubleshooting
Common issues and solutions:
- TimeoutError : Increase
HTTP_TIMEOUT
in config.py
- No Results : Try different search terms or verify the library name
- HTTP Errors : Check your internet connection and the documentation URL
π License
This project is licensed under the MIT License - see the LICENSE file for details.
π Acknowledgments
- FastMCP for the core functionality
- DuckDuckGo for search capabilities
- pytest for testing framework
- All supported documentation providers