MD

mrmartinimo/docmost-mcp

Developer tools

Эта страница переведена автоматически. Технические детали смотрите в оригинале. Открыть оригинал

32 stars 19 forks Качество 70 Тренд 11MIT

Сервер Model Context Protocol (MCP) для Docmost, позволяющий агентам ИИ управлять пространствами и страницами документации.

Обзор

Сервер MCP для Docmost, позволяющий агентам ИИ искать, создавать, изменять и организовывать страницы и пространства документации. Умный инструмент для создания. Создает контент (через импорт) и обрабатывает иерархию (вставку под материнскую компанию) за один раз. - : Обновление содержимого и/или заголовка страницы. Обновления выполняются в режиме реального времени (WebSocket). Удалить одну или несколько страниц сразу. Организуйте страницы иерархически, переместив их на новый родитель или корень. Полнотекстовый поиск по пространствам с дополнительной фильтрацией пространства (запрос, spaceId). Получите информацию о текущем рабочем пространстве Docmost. Просмотр всех пространств в пределах текущего рабочего пространства. Просмотр всех групп в пределах текущего рабочего пространства. - Перечислите страницы в пространстве (упорядоченном обновленным При спуске). - Получить полный контент и метаданные конкретной страницы. Содержимое страницы автоматически преобразуется из внутреннего формата Docmost ProseMirror/TipTap JSON для очистки Markdown для простого потребления агентов.

Обзор (машинный перевод)

Сервер MCP для Docmost, позволяющий агентам ИИ искать, создавать, изменять и организовывать страницы и пространства документации.

Особенности

###Управление

  • create_page: Умный инструмент создания. Создает контент (через импорт) и обрабатывает иерархию (вставку под материнскую компанию) за один раз. update_page: Обновление содержимого и/или заголовка страницы. Обновления выполняются в режиме реального времени (WebSocket). delete_page /delete_pages: Удалить одну или несколько страниц сразу.
  • move_page: Организуйте страницы иерархически, переместив их на новый родитель или корень.

###Исследование и поиск

[[Т5]]: Полнотекстовый поиск по пространствам с дополнительной фильтрацией пространства ([T6], [T7]).

  • get_workspace: Получите информацию о текущем рабочем пространстве Docmost.
  • list_spaces: Просмотр всех пространств в пределах текущего рабочего пространства. list_groups: Просмотр всех групп в рамках текущего рабочего пространства.
  • list_pages: В этом случае они будут вписываться в листы, расположенные в пространстве updatedAt. [[Т13]]: Получите полный контент и метаданные конкретной страницы.

Технические детали

Эта страница переведена автоматически. Технические детали смотрите в оригинале.

README

Docmost MCP Server

A Model Context Protocol (MCP) server for Docmost, enabling AI agents to search, create, modify, and organize documentation pages and spaces.

Features

Core Management

  • create_page: Smart creation tool. Creates content (via import) AND handles hierarchy (nesting under a parent) in one go.
  • update_page: Update a page’s content and/or title. Updates are performed via real-time collaboration (WebSocket).
  • delete_page / delete_pages: Delete single or multiple pages at once.
  • move_page: Organize pages hierarchically by moving them to a new parent or root.

Exploration & Retrieval

  • search: Full-text search across spaces with optional space filtering (query, spaceId).
  • get_workspace: Get information about the current Docmost workspace.
  • list_spaces: View all spaces within the current workspace.
  • list_groups: View all groups within the current workspace.
  • list_pages: List pages within a space (ordered by updatedAt descending).
  • get_page: Retrieve full content and metadata of a specific page.

Technical Details

  • Automatic Markdown Conversion: Page content is automatically converted from Docmost’s internal ProseMirror/TipTap JSON format to clean Markdown for easy agent consumption. Supports all Docmost extensions including callouts, task lists, math blocks, embeds, and more.
  • Smart Import API: Uses Docmost’s import API to ensure clean Markdown-to-ProseMirror conversion when creating pages.
  • Child Preservation: The update_page tool creates a new page ID but effectively simulates an in-place update by reparenting existing child pages to the new version.
  • Pagination Support: Automatically handles pagination for large datasets (spaces, pages, groups).
  • Filtered Responses: API responses are filtered to include only relevant information, optimizing data transfer for agents.

Installation

npm install
npm run build

Configuration

This server requires the following environment variables to be set:

  • DOCMOST_API_URL: The full URL to your Docmost API (e.g., https://docs.example.com/api).
  • DOCMOST_EMAIL: The email address for authentication.
  • DOCMOST_PASSWORD: The password for authentication.

usage with Claude Desktop / generic MCP Client

Add the following to your MCP configuration (e.g. claude_desktop_config.json):

{
  "mcpServers": {
    "docmost-local": {
      "command": "node",
      "args": ["./build/index.js"],
      "env": {
        "DOCMOST_API_URL": "http://localhost:3000/api",
        "DOCMOST_EMAIL": "[email protected]",
        "DOCMOST_PASSWORD": "test"
      }
    }
  }
}

Development

# Watch mode
npm run watch

# Build
npm run build

License

MIT

Открыть полный README на GitHub

Установка

This server does not publish a one-line install command.

Open the repository installation guide Новичок в MCP? Начните с руководства на mcpskill.org →

Конфигурация

{ "mcpServers": { "docmost-local": { "command": "node", "args": ["./build/index.js"], "env": { "DOCMOST_API_URL": "http://localhost:3000/api", "DOCMOST_EMAIL": "[email protected]", "DOCMOST_PASSWORD": "test" } } } }