MD

mrmartinimo/docmost-mcp

Developer tools

このページは AI により自動翻訳されています。技術的な詳細は原文をご確認ください。 原文を見る

32 stars 19 forks 品質 70 トレンド 11MIT

Docmost 用のモデルコンテキストプロトコル (MCP) サーバーで、AI エージェントがドキュメントスペースやページを管理することができます.

概要

Docmost 用のモデルコンテキストプロトコル (MCP) サーバーで、AI エージェントがドキュメントページやスペースを検索、作成、変更、および整理できるようにします。 - : スマート作成ツール コンテンツ(インポート)を作成し、階層(親の下にネスティング)を1つに処理します。 - : ページのコンテンツやタイトルを更新します。 リアルタイムコラボレーション(WebSocket)でアップデートを行います。 - : 一度に単一ページまたは複数のページを削除します。 - : ページを階層的に整理し、新しい親やルートに移動します。 - :オプションのスペースフィルタリング(query、SpaceId)でスペース全体で全文検索。 - : 現在のDocmostのワークスペースに関する情報を取得します。 - : 現在のワークスペース内の全てのスペースを表示 - : 現在のワークスペース内のすべてのグループを表示します。 - : スペース内の一覧ページ(更新順) - : 特定のページのフルコンテンツとメタデータを取得します。 - : ページのコンテンツは、Docmostの内部ProseMirror/TipTap JSON形式から自動的に変換され、簡単にエージェント消費のためのMarkdownをきれいにします.

概要(AI 翻訳)

Docmost 用のモデルコンテキストプロトコル (MCP) サーバーで、AI エージェントがドキュメントページやスペースを検索、作成、変更、および整理できるようにします。

##特徴

コアマネジメント

-[create_page: スマートな作成用具。 コンテンツ(インポート)を作成し、階層(親の下にネスティング)を1つに処理します。 -[update_page: ページのコンテンツやタイトルを更新します。 リアルタイムコラボレーション(WebSocket)でアップデートを行います。 -[delete_page/[delete_pages]: 単一ページまたは複数のページを一度に削除します。 -[move_page: それらを新しい親または根に動かすことによって階層的にページを整理します。

探索と検索

-[search: オプションのスペースフィルタリング([query]]、spaceId])で、スペース全体で全文検索。 -[get_workspace: 現在のDocmostワークスペースに関する情報を入手してください。

  • [list_spaces: 現行のワークスペース内の全てのスペースを表示 -[list_groups**: 現在のワークスペース内のすべてのグループを表示します。
  • [list_pages**: スペース内のリストページ([updatedAt順に並べ替え)。
  • [get_page: 特定のページのフルコンテンツとメタデータを取得します。

技術的な細部

このページは AI により自動翻訳されています。技術的な詳細は原文をご確認ください。

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

GitHub で README 全文を見る

インストール

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" } } } }