Arabold Docs MCP Server

🚀 ドキュメント管理システム docs - mcp

docs - mcp は、Model Context Protocol (MCP) を用いたドキュメントの管理と制御を行うサーバーです。ドキュメントの格納、バージョン管理、拡張性に優れた機能を提供します。

🚀 クイックスタート

docs - mcp を使用する前に、まずはインストールを行います。インストール手順については INSTALL.md を参照してください。

✨ 主な機能

1. ドキュメントの格納と管理
   • ドキュメントは階層構造で組織され、Markdown、JSON などの複数の形式をサポートしています。
   • MCP プロトコルを通じたリモートドキュメントのやり取りが可能です。
2. バージョン管理
   • 各ドキュメントには一意のバージョン番号と変更履歴があります。
   • セマンティックバージョニングシステムに対応しています。
3. 拡張性
   • 豊富なプラグインインターフェースを提供し、カスタム機能の拡張が可能です。
   • CI/CD、IDE などの様々なツールやサービスとの統合をサポートしています。

📦 インストール

インストール手順については INSTALL.md を参照してください。

💻 使用例

基本的な使用法

# docs - mcp サーバーを起動する
node dist/server.js --port 3000

# ドキュメント管理機能を使用する
curl -X POST http://localhost:3000/docs/create \
     -H "Content-Type: application/json" \
     -d '{"title": "我的第一个文档", "content": "这是我的第一个文档内容"}'

# ドキュメントリストを表示する
curl http://localhost:3000/docs/list

# 特定のドキュメントを取得する
curl http://localhost:3000/docs/[doc_id]

# ドキュメントを更新する
curl -X PUT http://localhost:3000/docs/[doc_id] \
     -H "Content-Type: application/json" \
     -d '{"title": "更新后的标题", "content": "这是更新后的内容"}'

# ドキュメントを削除する
curl -X DELETE http://localhost:3000/docs/[doc_id]

高度な使用法

サーバー起動時のオプション指定

node dist/server.js [--port <ポート>] [--env <環境>]

• --port: サーバーがリッスンするポートを指定します。デフォルトは 3000 です。
• --env: 実行環境（development、production など）を指定します。デフォルトは development です。

ドキュメント管理コマンド

npm run docs-mcp <コマンド> [-- <引数...>]

コマンド:
  create       新しいドキュメントを作成する
  list         すべてのドキュメントをリストする
  get          特定のドキュメントを取得する
  update       既存のドキュメントを更新する
  delete       ドキュメントを削除する

📚 ドキュメント

ドキュメントのバージョン管理

docs - mcp はセマンティックバージョニングシステムをサポートしています。ドキュメントが更新されるたびに、自動的に新しいバージョン番号が生成され、変更履歴が記録されます。

拡張とプラグイン

docs - mcp は豊富なプラグインインターフェースを提供しており、開発者は必要に応じて機能を拡張することができます。

ログプラグイン

const { Logger } = require('@modelcontextprotocol/mcp-core').Logger;

module.exports = {
  logger: new Logger({
    level: 'debug',
    handlers: [
      // カスタムログハンドラーを追加する
    ],
  }),
};

認証プラグイン

const { Auth } = require('@modelcontextprotocol/mcp-core').Auth;

module.exports = {
  auth: new Auth({
    provider: 'custom',
    // カスタム認証プロバイダーを設定する
  }),
};

サンプルプロジェクト

より多くのサンプルを見るには、DOCS - MCP サンプル を参照してください。

🔧 技術詳細

コード構造の概要

docs-mcp/
├── src/                 # ソースコードディレクトリ
│   ├── server.js       # メインサーバーファイル
│   ├── commands/       # コマンドライン処理モジュール
│   └── plugins/        # プラグインシステムの実装
├── dist/               # コンパイル出力ディレクトリ
├── package.json        # プロジェクトの依存関係と設定
└── .env.example        # 環境変数のサンプルファイル

開発のクイックスタート

# リポジトリをクローンする
git clone https://github.com/modelcontextprotocol/docs-mcp.git
cd docs-mcp

# 依存関係をインストールする
npm install

# 開発サーバーを起動する
npm run dev

# プロジェクトをコンパイルする
npm run build

貢献ガイド

docs - mcp に貢献するには、CONTRIBUTING.md を参照してください。

📄 ライセンス

本READMEにはライセンス情報が記載されていないため、このセクションは表示されません。

問題とサポート

問題が発生した場合は、DOCS - MCP 問題追跡 でフィードバックを送信するか、質問を投稿してください。

⚠️ 重要提示

本プロジェクトは実験的なものであり、まだ完全に安定していません。使用する前に関連ドキュメントをよく読み、データのバックアップを行ってください。