67 lines
1.4 KiB
Markdown
67 lines
1.4 KiB
Markdown
# Outline MCP Server
|
|
|
|
A lightweight MCP server for interacting with self-hosted [Outline](https://www.getoutline.com/) knowledge bases.
|
|
|
|
## Features
|
|
|
|
- **4 specific tools** for common operations (search, get document, list collections)
|
|
- **API passthrough** for full Outline API coverage
|
|
- **Embedded API reference** resource for agent self-service
|
|
- **Docker-ready** with health checks
|
|
|
|
## Tools
|
|
|
|
| Tool | Description |
|
|
|------|-------------|
|
|
| `search_documents` | Full-text search across all documents |
|
|
| `get_document` | Retrieve a document by ID with Markdown content |
|
|
| `list_collections` | List all collections in the workspace |
|
|
| `list_collection_documents` | List documents within a specific collection |
|
|
| `outline_api_call` | Raw API passthrough for any Outline endpoint |
|
|
|
|
## Resources
|
|
|
|
| URI | Description |
|
|
|-----|-------------|
|
|
| `outline://api-reference` | Comprehensive Outline API documentation |
|
|
|
|
## Configuration
|
|
|
|
Copy `.env.example` to `.env` and configure:
|
|
|
|
```bash
|
|
OUTLINE_API_URL=https://docs.example.com
|
|
OUTLINE_API_TOKEN=your_api_token_here
|
|
```
|
|
|
|
Get your API token from Outline: **Settings > API Tokens**
|
|
|
|
## Running
|
|
|
|
### Docker Compose
|
|
|
|
```bash
|
|
docker compose up -d
|
|
```
|
|
|
|
### Local Development
|
|
|
|
```bash
|
|
pip install -e .
|
|
python server.py
|
|
```
|
|
|
|
## Health Check
|
|
|
|
```bash
|
|
curl http://localhost:8000/health
|
|
```
|
|
|
|
## MCP Endpoint
|
|
|
|
The MCP server is available at `http://localhost:8000/mcp`
|
|
|
|
## License
|
|
|
|
MIT
|