MCP Outline Server

by Vortiago
Verified

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Integrations

  • Supports exporting documents as markdown from Outline.

  • Allows AI assistants to interact with Outline document services for document search, collection management, document reading/creation/editing, comment management, and backlink management.

Servidor de esquema MCP

Un servidor de Protocolo de Contexto de Modelo (MCP) que permite que los asistentes de IA interactúen con Outline ( https://www.getoutline.com )

Descripción general

Este proyecto implementa un servidor de Protocolo de Contexto de Modelo (MCP) que permite a los asistentes de IA (como Claude) interactuar con los servicios de documentos de Outline, proporcionando un puente entre las interacciones en lenguaje natural y las capacidades de gestión de documentos de Outline.

Características

Implementado actualmente:

  • Búsqueda de documentos : busque documentos por palabras clave
  • Gestión de colecciones : enumere colecciones y visualice la estructura del documento
  • Lectura de documentos : leer el contenido del documento y exportarlo como Markdown
  • Gestión de comentarios : ver y agregar comentarios en los documentos
  • Creación de documentos : crear nuevos documentos en colecciones
  • Edición de documentos : actualizar el contenido del documento y mover documentos
  • Gestión de vínculos de retroceso : ver documentos que enlazan a un documento específico

Empezando

Prerrequisitos

  • Python 3.10+
  • Cuenta de esquema con acceso a API
  • Clave API de Outline (obténgala desde la configuración de su cuenta de Outline)

Instalación

# Clone the repository git clone https://github.com/Vortiago/mcp-outline.git cd mcp-outline # Install in development mode uv pip install -e ".[dev]"

Configuración

Cree un archivo .env en la raíz del proyecto con las siguientes variables:

# Outline API Configuration OUTLINE_API_KEY=your_outline_api_key_here # For cloud-hosted Outline (default) # OUTLINE_API_URL=https://app.getoutline.com/api # For self-hosted Outline # OUTLINE_API_URL=https://your-outline-instance.example.com/api

Ejecución del servidor

# Development mode with the MCP Inspector mcp dev src/mcp_outline/server.py # Or use the provided script ./start_server.sh # Install in Claude Desktop (if available) mcp install src/mcp_outline/server.py --name "Document Outline Assistant"

Ejemplos de uso

Buscar documentos

Search for documents containing "project planning"

Colecciones de listas

Show me all available collections

Leer un documento

Get the content of document with ID "docId123"

Crear un nuevo documento

Create a new document titled "Research Report" in collection "colId456" with content "# Introduction\n\nThis is a research report..."

Añadir un comentario

Add a comment to document "docId123" saying "This looks great, but we should add more details to the methodology section."

Mover un documento

Move document "docId123" to collection "colId789"

Contribuyendo

¡Agradecemos sus contribuciones! No dude en enviar una solicitud de incorporación de cambios.

Desarrollo

# Run tests uv run pytest tests/ # Format code uv run ruff format .

Licencia

Este proyecto está licenciado bajo la licencia MIT: consulte el archivo de LICENCIA para obtener más detalles.

Expresiones de gratitud

You must be authenticated.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

Un servidor de protocolo de contexto de modelo que permite a los asistentes de IA como Claude interactuar con los servicios de documentos de Outline, respaldando la búsqueda, lectura, creación, edición y gestión de comentarios de documentos.

  1. Overview
    1. Features
      1. Getting Started
        1. Prerequisites
        2. Installation
        3. Configuration
        4. Running the Server
      2. Usage Examples
        1. Search for Documents
        2. List Collections
        3. Read a Document
        4. Create a New Document
        5. Add a Comment
        6. Move a Document
      3. Contributing
        1. Development
          1. License
            1. Acknowledgments
              ID: yejga73oe8