Skip to main content
Glama
mnbro

outline-wiki-mcp

by mnbro
README.md
# outline-wiki-mcp

Safe, control-plane-aware MCP server bootstrap for Outline Wiki.

Current status: implementation-start only. This repository does not claim production readiness, W3/W4/W5 workflow maturity, or C5 conformance.

## Scope

TASK-001 implements the project skeleton and initial diagnostics surface:

- `outline_validate_connection`
- `outline_capability_report`
- `outline_diagnostics`

Full Outline API coverage, uploads, semantic search, and cross-document analysis are intentionally not implemented in this task.

## Configuration

```bash
OUTLINE_BASE_URL=https://outline.example.com
OUTLINE_API_TOKEN=...
OUTLINE_MCP_MODE=agentic
OUTLINE_READ_ONLY=true
```

Safe defaults:

- agentic mode is the default
- read-only mode is the default
- secrets are redacted from diagnostics and errors
- Outline content is treated as untrusted data when content tools are added

## MCP Client

```json
{
  "mcpServers": {
    "outline-wiki-mcp": {
      "command": "uv",
      "args": ["run", "outline-wiki-mcp"],
      "env": {
        "OUTLINE_BASE_URL": "https://outline.example.com",
        "OUTLINE_API_TOKEN": "..."
      }
    }
  }
}
```

## Development

```bash
uv lock
uv run ruff check .
uv run pytest
uv run python -m mypy src tests
uv build
uv pip check
uv run mkdocs build --strict
```

## License

This project is licensed under the PolyForm Internal Use License 1.0.0.

You may use the software for internal business purposes, including internal commercial operations. You may not distribute, sublicense, transfer, resell, or include the software in custom solutions, hosted services, managed services, SaaS offerings, or packaged products sold or delivered to third parties unless a separate commercial license is granted.

See the LICENSE file for the full legal terms.

TDQS

A4.2/5.0

Scored across 3 tools

Disambiguation5/5

Each tool has a distinct purpose: capability report for metadata, diagnostics for runtime info, and connection validation. No overlap.

Naming Consistency5/5

All tools follow a consistent 'outline_X' snake_case pattern, making them predictable.

Tool Count5/5

With only 3 tools, the scope is narrow but well-defined for a health-check server; each tool is necessary.

Completeness5/5

The tool set covers all essential aspects of server capability reporting, diagnostics, and connection validation without missing operations.

Maintenance

ActivitySlowing
ResponsivenessSyncing