Prerequisites
Before you begin, ensure you have:- Python 3.13+ installed on your system
- uv package manager installed
Installation Steps
Install dependencies
Use uv to install all required Python dependencies:This command reads the project configuration and installs all dependencies specified in
pyproject.toml.Configure environment variables
Copy the example environment file to create your own configuration:The See the Configuration page for detailed information about all available environment variables.
.env.example file contains all available configuration options with sensible defaults. You can edit the .env file to customize settings for your environment.Example .env configuration:For local development, set
MCP_HOST=127.0.0.1 to follow MCP security best practices. This ensures the server only accepts connections from your local machine.Load environment variables
Load the environment variables into your shell session:This command exports all variables from the
.env file to your current shell.Start the server
Run the MCP server:The server will start on the configured host and port (default:
http://127.0.0.1:8000).Next Steps
Now that you have the server running:- Connect a chatbot: Follow the connection instructions in the README to integrate with Claude, ChatGPT, or other MCP clients
- Configure advanced settings: See the Configuration page for all available options
- Deploy with Docker: Check out the Docker deployment guide for production deployments
Troubleshooting
Port already in use
If port 8000 is already in use, change theMCP_PORT in your .env file: