Mcpinstructionserver

🚀 MCP指令サーバー（MCPInstructionServer）

TypeScriptベースのモデルコンテキストプロトコル（Model Context Protocol）サーバーで、AIアシスタントが構造化されたMarkdown指令を発見しアクセスするために使用されます。

このサーバーは、ClaudeなどのAIアシスタントが標準化されたインターフェースを通じて集中型のMarkdown指令ライブラリにアクセスできるようにします。指令をMarkdownファイルとして組織することで、以下のことが可能になります。

• 集中的なプロンプト知識ベースを作成する
• バージョン管理された構造化されたガイドドキュメントを維持する
• AIアシスタントが必要に応じて特定の指令を検索し取得できるようにする
• 一貫したAI支援タスクモードを確立する

🚀 クイックスタート

前提条件

• Node.js 18+（ESMサポートのため）
• npmまたはyarn
• TypeScriptとMarkdownに関する基本的な知識

インストール

# リポジトリをクローンする
git clone https://github.com/yourusername/MCPInstructionServer.git
cd MCPInstructionServer

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

# プロジェクトをビルドする
npm run build

サーバーの起動

# 指令ディレクトリを指定して起動
npm start -- /path/to/instructions

# またはnodeを直接使用する
node dist/index.js /path/to/instructions

✨ 主な機能

• シンプルなファイルシステムストレージ：ディレクトリ内のMarkdownファイルのみで動作します。
• 再帰的なディレクトリスキャン：階層構造で指令を組織できます。
• パスセキュリティ：ディレクトリトラバーサルを防止し、許可されたディレクトリ外のファイルへのアクセスを制限します。
• 自動要約抽出：各ドキュメントからH1タイトルと最初の段落を抽出します。
• モデルコンテキストプロトコルサポート：MCPを実装したAIアシスタントと互換性があります。

🔧 技術詳細

動作原理

サーバーは指定されたディレクトリ（およびそのサブディレクトリ）内のMarkdownファイルをインデックス化し、各ファイルを指令ドキュメントとして扱います。サーバーは各ドキュメントのタイトルと最初の段落を抽出し、検索可能な要約を生成します。

AIアシスタントは以下の操作を実行できます。

1. すべての利用可能な指令とその要約をリストする
2. 特定の指令のIDを要求する

📦 インストール

# リポジトリをクローンする
git clone https://github.com/yourusername/MCPInstructionServer.git
cd MCPInstructionServer

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

# プロジェクトをビルドする
npm run build

💻 使用例

基本的な使用法

サーバーの起動

# 指定指令ディレクトリでサーバーを起動
npm start -- /path/to/instructions

# またはnodeを直接使用
node dist/index.js /path/to/instructions

指令の作成

指令は.md拡張子の単純なMarkdownファイルです。各ファイルは以下の構造に従う必要があります。

# 指令タイトル

この指令の目的の簡単な説明。この最初の段落は、リスト内の指令の要約として使用されます。

## 詳細情報

より詳細な情報を含む他のセクション...

## 例

使用例、コードスニペットなど。

ディレクトリ構造の例

instructions/
├── api/
│   ├── authentication.md
│   └── rate-limiting.md
├── design/
│   ├── color-system.md
│   └── typography.md
└── general/
    ├── code-review.md
    └── git-workflow.md

指令のアクセス

サーバーは2つのMCPツールを提供します。

1. listInstructions

すべての利用可能な指令のリストとそのIDおよび要約を返します。 例の応答：

id: api/authentication
summary: 認証API - このファイルは、システムで使用される認証プロトコルの概要を説明しています。

id: design/typography
summary: タイポグラフィガイド - このガイドは、タイポグラフィのスケールと使用規則を説明しています。

2. readInstruction

指令IDを受け取り、対応する指令の完全な内容を返します。 例のリクエスト：{ "id": "api/authentication" }

開発

# 開発モードで実行（自動再起動）
npm run dev -- /path/to/instructions

# テストを実行
npm test

📄 ライセンス

MIT

⚠️ 重要提示

サーバーはすべてのパスを検証してディレクトリトラバーサル攻撃を防止します。指定された指令ディレクトリ内のファイルのみにアクセスでき、書き込み機能はなく読み取りのみが許可されます。

💡 使用建议

貢献を歓迎します！自由にPull Requestを送信してください。