0.1.0 • Published 8 months ago

@mscrivo/outline-mcp-server v0.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

@mscrivo/outline-mcp-server

An MCP server for connecting to Outline wikis. This server provides tools to search and access documents from your Outline knowledge base through the Model Context Protocol (MCP).

Features

Tools

  • search_documents - Search for documents in your Outline wiki instance
    • Takes a search query and optional parameters for number of results and max characters
    • Returns relevant document matches with context

Installation & Usage

This MCP server requires two environment variables to be set:

You can run this MCP server directly using npx with the environment variables:

OUTLINE_API_KEY=your_api_key OUTLINE_INSTANCE_URL=your_instance_url npx @mscrivo/outline-mcp-server

Configuration

To use with Claude Desktop, add the server config:

On MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json On Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "outline": {
      "command": "npx",
      "args": ["@mscrivo/outline-mcp-server"],
      "env": {
        "OUTLINE_API_KEY": "your_api_key",
        "OUTLINE_INSTANCE_URL": "your_instance_url"
      }
    }
  }
}

Development

Clone the repository and install dependencies:

npm install

Build the server:

npm run build

For development with auto-rebuild:

npm run watch

Debugging

Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the MCP Inspector, which is available as a package script:

npm run inspector

The Inspector will provide a URL to access debugging tools in your browser.

License

MIT