mcplocalserver

プロジェクトの説明

このプロジェクトは、Windows OS 向けの MCP Server という Node.js アプリケーションです。LLM ベースのツール（Copilot Agents など）間のシームレスな通信を実現するローカルミドルウェアとして機能します。サーバーはローカルで実行するように設計されており、Visual Studio Code や Visual Studio などの IDE と併用するのが理想的です。

MCP Server はサードパーティー製ライブラリ @modelcontextprotocol/sdk を使用しており、Inspector ツールを使ってウェブブラウザー上で実行およびテストできます。

このプロジェクトには、コーディングを支援するドキュメントやガイドファイルが含まれる、あらかじめ用意された ./data ディレクトリがあります。また、./data/prompts サブフォルダーには、Copilot Agents の動作と出力を導くためのプロンプトファイルが含まれています。

設定

次の環境変数を設定します。

• GUIDE_FILES_DIR：ローカルのガイドファイルが含まれるディレクトリへのパス（例：.\\data）。
• PROMPT_DIR：プロンプトディレクトリへのパス（例：.\\dat\\prompts）。プロンプトファイルは .txt ファイルで、prompt_ という接頭辞で始まる必要があります。

これらの変数は .env ファイルで設定するか、アプリの実行時にターミナルから直接渡すことができます。 パス名では "\" を二重にする必要があることに注意してください。

.env ファイルの例：

GUIDE_FILES_DIR=C:\\pathToYourProject\\mcpLocalServer\\data\
PROMPT_DIR=C:\\pathToYourProject\\mcpLocalServer\\data\\prompts

💡 パスは、ガイドファイルとプロンプトファイルが置かれているフォルダーを直接指す必要があります。data の下に prompts サブフォルダーを作成することをおすすめします。

機能

使用できる組み込みツールは 3 つあります。

• ListAvailableFilesTool – data ディレクトリにあるすべての .txt ファイルを一覧表示します。
• ListPromptsTool – data/prompts ディレクトリにあるすべてのプロンプトファイルを一覧表示します。
• ReadLocalFileTool – ファイルの接頭辞に応じて、data または data/prompts にあるファイルの内容を読み取って返します。

使い方

1. 依存関係をインストールします。

   npm install
   

2. .env ファイルを使用するか、ターミナルから直接、環境変数を設定します。

3. プロジェクトをビルドします。

   npm run build
   

4. ブラウザーでテストするためにサーバーを実行します。

   npx @modelcontextprotocol/inspector build/index.js
   

5. MCP 対応クライアント（Copilot for Visual Studio Code など）を使用して、サーバーとやり取りします。

Visual Studio Code での使い方

Copilot と統合するには、次の手順に従います。

1. プロジェクトに .vscode ディレクトリを作成します。
2. 次の内容で mcp.json ファイルを追加します。

{
  "inputs": [],
  "servers": {
    "local": {
      "command": "node",
      "args": ["C:\\pathToMcpLocalServerProjectInYourPC\\build\\index.js"]
    }
  }
}

3. 公式ドキュメントの手順に従って、VS Code で MCP サポートを有効にします。

4. サーバーが停止している場合は、次のコマンドで起動します。 ctrl+shift+p MCP:List Servers -> 次にサーバー名を選択し、アクション [""Start","Stop","Restart"] をクリックします。

5. OUTPUT ターミナルに MCP サーバーのログが表示されます。 2025-05-30 08:35:10.855 [warning] [server stderr] ✅ Local MCP server running on stdio 2025-05-30 08:35:10.864 [info] Discovered 3 tools

⚠️ エージェントに対応した最新バージョン、またはプレリリース版の Visual Studio Code を使用していることを確認してください。

ガイドファイルとカスタムプロンプトを使用するプロンプトの例： その他の例は "../docs/VisualCode_Copilot_Examples" で確認できます。

Description: 💾 Create C# Class
Prompt text:
Use the local MCP server.

Step 1: Load the prompt file named "prompt_csharp_class_authoring.txt" using the "read_local_file" tool with the argument "fileName".

Step 2: Once the file is loaded, execute all instructions defined in that file. If those instructions require using additional tools, follow them accordingly.

Step 3: After completing all steps from the prompt file, generate a C# (.cs) file with a class named House. The class should contain Windows and Doors properties, and include methods to build them.

Ensure that the implementation follows all guidelines and conventions from the loaded prompt file.

カスタマイズ

独自のガイドファイルやプロンプトファイルを追加して、このプロジェクトを拡張できます。

• ガイドファイルを追加する：guide_ という接頭辞が付いた .txt ファイルを作成し、GUIDE_FILES_DIR で定義されたフォルダーに配置します。
• プロンプトファイルを追加する：prompt_ という接頭辞が付いた .txt ファイルを作成し、PROMPT_DIR で定義されたフォルダーに配置します。

カスタムツールを開発することもできます。

1. src/tools ディレクトリに新しい YourTool.ts ファイルを作成します。
2. localMcpServer.ts でツールを登録します。
3. テストを実行する前に、プロジェクトを再ビルドします。

ライセンス

このプロジェクトは MIT License の下でライセンスされています。