项目描述
这个项目是一个用于Windows操作系统的Node.js应用程序，名为 MCP服务器它充当本地中间件，用于基于LLM的工具（例如Copilot代理）之间的无缝通信。服务器设计为在本地运行，最好与Visual Studio Code或Visual Studio等IDE一起运行。
MCP服务器使用第三方库 @modelcontextprotocol/sdk，它允许您使用检查器工具在web浏览器中运行和测试它。
该项目包括一个预定义的 ./data 包含用于辅助编码的文档和指南文件的目录。此外，a ./data/prompts 子文件夹包含Copilot代理用于指导其行为和输出的提示文件。
配置
设置以下环境变量：
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💡 路径应直接指向您的指南和提示文件所在的文件夹。建议创建一个prompts子文件夹下data.
特性
您可以使用3个内置工具：
ListAvailableFilesTool–列出所有.txt文件位于data目录。ListPromptsTool–列出位于中的所有提示文件data/prompts目录。ReadLocalFileTool–从以下任一位置读取并返回文件内容data或data/prompts，具体取决于文件前缀。
用法
- 安装依赖项：
npm install- 使用配置环境变量
.env文件或直接在终端中。
- 构建项目：
npm run build- 运行服务器进行浏览器测试：
npx @modelcontextprotocol/inspector build/index.js- 使用MCP兼容客户端（如Visual Studio Code的Copilot）与服务器交互。
与Visual Studio代码一起使用
要与Copilot集成，请执行以下操作：
- 创建一个
.vscode项目中的目录。 - 添加a
mcp.json包含以下内容的文件：
{
"inputs": [],
"servers": {
"local": {
"command": "node",
"args": ["C:\\pathToMcpLocalServerProjectInYourPC\\build\\index.js"]
}
}
}- 遵循以下说明 官方文件 以在VS Code中启用MCP支持。
- 如果使用以下命令禁用服务器，请启动服务器：
ctrl+shift+p MCP：列出服务器->接下来选择您的服务器名称并单击操作\[“开始”、“停止”、“重新启动”\]
- 您应该在OUTPUT终端中看到MCP服务器日志：
2025-05-30 08:35:10.855\[警告\]\[服务器错误\]✅ 在stdio上运行的本地MCP服务器 2025-05-30 08:35:10.864\[信息\]发现3个工具
⚠️ 确保您使用的是支持代理的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.定制
您可以通过添加自己的指南或提示文件来扩展此项目：
- 添加指南文件：创建一个
.txt带有前缀的文件guide_并将其放置在由定义的文件夹中GUIDE_FILES_DIR. - 添加提示文件：创建一个
.txt带有前缀的文件prompt_并将其放置在由定义的文件夹中PROMPT_DIR.
您还可以开发自定义工具：
- 创建新
YourTool.ts文件在src/tools目录。 - 在中注册该工具
localMcpServer.ts. - 在运行测试之前重建项目。
许可证
该项目根据 MIT许可证.