Project Description

@michalpawlik93

About Project Description

No overview available yet

Config

Add this server to your MCP-compatible client using the configuration below.

{
  "mcpServers": {
    "mcpLocalServer": {
      "command": "npx",
      "args": [
        "@modelcontextprotocol/inspector",
        "build/index.js"
      ]
    }
  }
}

Tools

No tools detected

We auto-extract tools from the README. The maintainer can list them under a ## Tools heading to populate this section.

Overview

What is MCP Server?

MCP Server is a Node.js application for Windows that acts as a local middleware for seamless communication between LLM-based tools (e.g., Copilot Agents) and local files or prompts. It is designed to run alongside an IDE like Visual Studio Code or Visual Studio.

How to use MCP Server?

Install dependencies (npm install), configure the environment variables GUIDE_FILES_DIR and PROMPT_DIR in a .env file, build the project (npm run build), then run it with npx @modelcontextprotocol/inspector build/index.js for browser testing. For integration with Visual Studio Code, create a .vscode/mcp.json file pointing to the built index.js and follow the official MCP documentation.

Key features of MCP Server

Three built-in tools: ListAvailableFilesTool, ListPromptsTool, ReadLocalFileTool
Supports custom guide files (prefix guide_) and prompt files (prefix prompt_)
Works with the @modelcontextprotocol/sdk and can be tested via the Inspector
Designed for local, offline use with IDEs like VS Code
Allows developers to create and register custom tools in TypeScript

Use cases of MCP Server

Provide LLM agents with local documentation and guide files for code generation
Use custom prompt files to control Copilot Agents’ behavior and output format
Enable an agent to read specific local files (e.g., coding standards) before writing code
Serve as a middleware for Copilot for Visual Studio Code to interact with project-specific resources

FAQ from MCP Server

What are the required environment variables?

Set GUIDE_FILES_DIR to the folder containing your guide files and PROMPT_DIR to the folder containing your prompt files. Use double backslashes in paths (e.g., C:\\path\\to\\data).

How do I integrate MCP Server with Visual Studio Code?

Create a .vscode/mcp.json file with a "servers" entry that specifies "node" as the command and the full path to build/index.js as the argument. Then use Ctrl+Shift+P and run MCP: List Servers to start the server.

What file types are supported?

Only .txt files are supported. Guide files must have the prefix guide_ and prompt files must have the prefix prompt_.

How can I add a custom tool?

Create a new .ts file in the src/tools directory, register the tool in localMcpServer.ts, then rebuild the project with npm run build.

How do I test MCP Server?

Run npx @modelcontextprotocol/inspector build/index.js to start the Inspector tool, which allows you to test the server in a web browser.

Frequently asked questions

What are the required environment variables?

Set `GUIDE_FILES_DIR` to the folder containing your guide files and `PROMPT_DIR` to the folder containing your prompt files. Use double backslashes in paths (e.g., `C:\\path\\to\\data`).

How do I integrate MCP Server with Visual Studio Code?

Create a `.vscode/mcp.json` file with a `"servers"` entry that specifies `"node"` as the command and the full path to `build/index.js` as the argument. Then use `Ctrl+Shift+P` and run `MCP: List Servers` to start the server.

What file types are supported?

Only `.txt` files are supported. Guide files must have the prefix `guide_` and prompt files must have the prefix `prompt_`.

How can I add a custom tool?

Create a new `.ts` file in the `src/tools` directory, register the tool in `localMcpServer.ts`, then rebuild the project with `npm run build`.

How do I test MCP Server?

Run `npx @modelcontextprotocol/inspector build/index.js` to start the Inspector tool, which allows you to test the server in a web browser.

Comments

Basic information

More Other MCP servers

Nginx UI

0xJacky

Yet another WebUI for Nginx

11.3K

Mobile Mcp

mobile-next

Model Context Protocol Server for Mobile Automation and Scraping (iOS, Android, Emulators, Simulators and Real Devices)

5.4K

IDA Pro MCP

mrexodia

AI-powered reverse engineering assistant that bridges IDA Pro with language models through MCP.

9.9K

Inbox Zero AI MCP

elie222

The world's best AI personal assistant for email. Open source app to help you reach inbox zero fast.

11.6K

Reactive Resume

amruthpillai

A one-of-a-kind resume builder that keeps your privacy in mind. Completely secure, customizable, portable, open-source and free forever. Try it out today!

39.5K