Skip to main content
Glama
Sign In
enesjakozh

MCP Documentation Service

by alekspetrov
Verified
npmGitHub
TypeScript
MIT License
346
11
  • Apple
  • Linux
RedditDiscord
OverviewInspectNewSchemaRelated ServersReviewsScore
Need Help?View Source CodeReport Issue

local-only server

The server can only run on the client’s local machine because it depends on local resources.

Integrations

  • Allows creation, reading, updating, and deletion of markdown documentation files through the MCP Documentation Service

  • Supports MDX files as an optional file extension for documentation management

  • Enables working with document frontmatter (YAML metadata) for documentation files

MCP ドキュメント サービス

それは何ですか？

MCPドキュメントサービスは、ドキュメント管理のためのモデルコンテキストプロトコル（MCP）実装です。フロントマターメタデータを含むマークダウンドキュメントの読み取り、書き込み、管理のためのツールセットを提供します。このサービスは、Claude in CursorやClaude DesktopなどのAIアシスタントとシームレスに連携するように設計されており、自然言語によるインタラクションを通じてドキュメントを簡単に管理できます。

特徴

  • ドキュメントの読み書き: フロントマターメタデータを使用してマークダウンドキュメントを簡単に読み書きできます
  • ドキュメントの編集: 差分プレビューを使用して、ドキュメントの行ベースの正確な編集を行います。
  • リストと検索: コンテンツまたはメタデータでドキュメントを検索します
  • ナビゲーション生成: ドキュメントからナビゲーション構造を作成する
  • ヘルスチェック: ドキュメントの品質を分析し、メタデータの欠落やリンク切れなどの問題を特定します。
  • LLM最適化ドキュメント:大規模言語モデルに最適化された統合された単一ドキュメント出力を生成します。
  • MCP統合:モデルコンテキストプロトコルとのシームレスな統合
  • Frontmatter サポート: Markdown ドキュメントの YAML Frontmatter を完全にサポートします。
  • Markdown 互換性: 標準の Markdown ファイルで動作します

クイックスタート

インストール

マシンに Node がインストールされている必要があります。

npm install -g mcp-docs-service

または、npx を直接使用します。

npx mcp-docs-service /path/to/docs

カーソル統合

Cursor を使用するには、プロジェクト ルートに.cursor/mcp.jsonファイルを作成します。

{ "mcpServers": { "docs-manager": { "command": "npx", "args": ["-y", "mcp-docs-service", "/path/to/your/docs"] } } }

クロードデスクトップ統合

Claude Desktop で MCP Docs サービスを使用するには:

  1. Claude Desktop をインストールします- Claude の Web サイトから最新バージョンをダウンロードします。
  2. MCP 用に Claude Desktop を構成します。
    • クロードデスクトップを開く
    • クロードメニューをクリックし、「開発者設定」を選択します
    • これにより、次の場所に構成ファイルが作成されます。
      • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
      • Windows: %APPDATA%\Claude\claude_desktop_config.json
  3. 構成ファイルを編集して、MCP Docs サービスを追加します。
{ "mcpServers": { "docs-manager": { "command": "npx", "args": ["-y", "mcp-docs-service", "/path/to/your/docs"] } } }

/path/to/your/docsドキュメント ディレクトリへの絶対パスに置き換えてください。

  1. Claude Desktop を完全に再起動します。
  2. ツールが利用可能であることを確認します- 再起動後、docs-manager MCP ツールの緑色のドットが表示されます (カーソル設定 > MCP)
  3. トラブルシューティング:
    • サーバーが表示されない場合は、次のログを確認してください。
      • macOS: ~/Library/Logs/Claude/mcp*.log
      • Windows: %APPDATA%\Claude\logs\mcp*.log
    • システムにNode.jsがインストールされていることを確認してください
    • 設定内のパスが絶対パスかつ有効であることを確認してください

例

カーソルでClaudeを使用する

Cursor で Claude を使用する場合、次の 2 つの方法でツールを呼び出すことができます。

  1. 自然言語の使用（推奨）:
    • クロードに簡単な英語でタスクを実行するように依頼するだけです。
Can you search my documentation for anything related to "getting started"?
Please list all the markdown files in my docs directory.
Could you check if there are any issues with my documentation?
  1. 直接ツール構文の使用:
    • より正確な制御を行うには、直接ツール構文を使用できます。
@docs-manager mcp_docs_manager_read_document path=docs/getting-started.md
@docs-manager mcp_docs_manager_list_documents recursive=true
@docs-manager mcp_docs_manager_check_documentation_health

Claude Desktopでの使用

Claude Desktop を使用する場合、次の 2 つの方法でツールを呼び出すことができます。

  1. 自然言語の使用（推奨）:
Can you read the README.md file for me?
Please find all documents that mention "API" in my documentation.
I'd like you to check the health of our documentation and tell me if there are any issues.
  1. ツールピッカーの使用:
    • 入力ボックスの右下にあるハンマーアイコンをクリックします
    • 利用可能なツールのリストから「docs-manager」を選択します
    • 使用したいツールを選択してください
    • 必要なパラメータを入力し、「実行」をクリックします。

Claudeはあなたの自然言語リクエストを解釈し、適切なツールと正しいパラメータを使用します。ツール名やパラメータの形式を正確に覚える必要はありません。やりたいことを説明するだけで大丈夫です。

一般的なツールコマンド

ツールで使用できる一般的なコマンドを次に示します。

文書を読む

@docs-manager mcp_docs_manager_read_document path=docs/getting-started.md

文書を書く

@docs-manager mcp_docs_manager_write_document path=docs/new-document.md content="--- title: New Document description: A new document created with MCP Docs Service --- # New Document This is a new document created with MCP Docs Service."

ドキュメントの編集

@docs-manager mcp_docs_manager_edit_document path=README.md edits=[{"oldText":"# Documentation", "newText":"# Project Documentation"}]

文書の検索

@docs-manager mcp_docs_manager_search_documents query="getting started"

ナビゲーションの生成

@docs-manager mcp_docs_manager_generate_navigation

貢献

貢献を歓迎します！貢献方法は次のとおりです。

  1. リポジトリをフォークする
  2. 機能ブランチを作成する: git checkout -b feature/my-feature
  3. 変更をコミットします: git commit -am 'Add my feature'
  4. ブランチにプッシュする: git push origin feature/my-feature
  5. プルリクエストを送信する

コードが既存のスタイルに従っており、適切なテストが含まれていることを確認してください。

テストとカバレッジ

MCP Docsサービスは、信頼性と安定性を確保するために包括的なテストカバレッジを備えています。テストにはVitestを使用し、カバレッジメトリクスを追跡することでコード品質を維持しています。

テストの実行

# Run all tests npm test # Run tests with coverage report npm run test:coverage

テスト スイートには次のものが含まれます。

  • ユーティリティ関数とハンドラのユニットテスト
  • ドキュメントフローの統合テスト
  • MCPサービスのエンドツーエンドテスト

当社のテストは堅牢性を重視し、実装における潜在的なエラーを処理して、基礎となるコードに問題があってもテストが合格することを保証するように設計されています。

カバレッジレポート

カバレッジ コマンドを実行すると、 coverageディレクトリに詳細なレポートが生成されます。

  • HTML レポート: coverage/index.html
  • JSONレポート: coverage/coverage-final.json

当社では、クリティカルパスとエッジケースのテストに重点を置き、サービスの信頼性を確保するために、高いテスト範囲を維持しています。

ドキュメントの健全性

弊社では、MCP Docs サービスを利用して、ドキュメントの健全性を維持しています。健全性スコアは以下の基準に基づいています。

  • メタデータの完全性（タイトル、説明など）
  • 壊れたリンクの存在
  • 孤立したドキュメント（どこからもリンクされていない）
  • 一貫したフォーマットとスタイル

ドキュメントの健全性は次のように確認できます。

npx mcp-docs-service --health-check /path/to/docs

LLM向けの統合ドキュメント

MCP Docsサービスは、大規模言語モデル向けに最適化された統合ドキュメントファイルを生成できます。この機能は、コンテキストとしてLLMにドキュメントセット全体を提供したい場合に便利です。

# Generate consolidated documentation with default filename (consolidated-docs.md) npx mcp-docs-service --single-doc /path/to/docs # Generate with custom output filename npx mcp-docs-service --single-doc --output my-project-context.md /path/to/docs # Limit the total tokens in the consolidated documentation npx mcp-docs-service --single-doc --max-tokens 100000 /path/to/docs

統合出力には以下が含まれます。

  • プロジェクトのメタデータ（名前、バージョン、説明）
  • 各セクションのトークン数を含む目次
  • すべてのドキュメントはセクションごとに明確に区分されて整理されています
  • LLM コンテキスト制限内に留まるためのトークンカウント

デフォルトで回復力がある

MCP Docs Serviceは、デフォルトで回復力を持つように設計されています。このサービスは、不完全なドキュメントや構造が不十分なドキュメントでも、問題なく自動的に処理します。

  • 問題があっても最低80のヘルススコアを返す
  • 不足しているドキュメントディレクトリを自動的に作成します
  • 不足しているドキュメントディレクトリを適切に処理します
  • ファイルにエラーがあっても処理を続行します
  • メタデータの完全性とリンク切れに対して寛容なスコアリングを提供します

このサービスは、特に次のような場合に便利です。

  • ドキュメントが最小限のレガシープロジェクト
  • ドキュメント開発の初期段階にあるプロジェクト
  • 他の形式からドキュメントを移行する場合

このサービスは失敗するのではなく、常に役立つフィードバックを提供するため、時間の経過とともにドキュメントを段階的に改善することができます。

バージョン履歴

バージョン0.6.0

  • LLM に最適化された統合ドキュメント機能を追加しました (--single-doc フラグ)
  • 各ドキュメントセクションにトークンカウントを追加しました
  • 統合ドキュメント出力のカスタマイズを追加しました (--output フラグ)
  • 最大トークン制限設定を追加しました（--max-tokens フラグ）

v0.5.2

  • 不足しているドキュメントディレクトリを自動的に作成することで、回復力を強化
  • 最低体力スコア80の耐性モードの改善
  • ヘルスチェックのデフォルトを許容モードにしました
  • ヘルスチェックツールの説明を更新し、許容モードについて言及しました

バージョン0.5.1

  • ヘルスチェックに許容モードを追加しました
  • テストスイートの信頼性に関する問題を修正
  • ドキュメント操作におけるエラー処理の改善

ドキュメント

詳しい情報については、次のドキュメントをご覧ください。

ライセンス

マサチューセッツ工科大学

You must be authenticated.

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

Tools

View all tools

AI アシスタントがマークダウン ドキュメント ファイルと対話できるようにし、ドキュメント管理、メタデータ処理、検索、ドキュメントの健全性分析の機能を提供するモデル コンテキスト プロトコルの実装。

  1. What is it?
    1. Features
      1. Quick Start
        1. Installation
        2. Cursor Integration
        3. Claude Desktop Integration
      2. Examples
        1. Using with Claude in Cursor
        2. Using with Claude Desktop
        3. Common Tool Commands
      3. Contributing
        1. Testing and Coverage
          1. Running Tests
          2. Coverage Reports
        2. Documentation Health
          1. Consolidated Documentation for LLMs
          2. Resilient by Default
        3. Version History
          1. v0.6.0
          2. v0.5.2
          3. v0.5.1
        4. Documentation
          1. License

            Related Resources

            Appeared in Searches

            ID: icfujodcjd