mcplocalserver

项目说明

该项目是一个适用于 Windows OS 的 Node.js 应用，名为 MCP Server。它作为本地中间件，可在基于 LLM 的工具（例如 Copilot Agents）之间实现无缝通信。该服务旨在本地运行，最好与 Visual Studio Code 或 Visual Studio 等 IDE 配合使用。

MCP Server 使用第三方库 @modelcontextprotocol/sdk，借助 Inspector 工具，你可以在 Web 浏览器中运行和测试它。

项目包含一个预定义的 ./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 的客户端（例如 Visual Studio Code 的 Copilot）与服务交互。

在 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

⚠️ 请确保使用支持 Agents 的最新版本或预发行版 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 许可。