MCP Vscode Template

🚀 MCP VSCode Template

This is an MCP server template for the VS Code Agent, which simplifies the setup and operation of MCP servers in the VS Code environment.

🚀 Quick Start

✨ Features

• Based on the work of Renae Schilg, with modifications such as not using Claude Desktop and significant changes to external-recon.py.
• Supports customizing Python versions and dependencies.
• Integrates with VS Code through settings.json for easy server configuration.

📦 Installation

1. Install uv: You can install uv in your preferred way. There are multiple options available. Refer to the official installation guide: https://docs.astral.sh/uv/getting-started/installation/
2. Initialize the project:

# Initialize the project
uv init external-recon
cd external-recon

3. Modify Python version requirements:
   • Change the Python version in the .python-version file to 3.11 or higher (higher than 3.8 or 3.10).
   • Modify requires-python = ">=3.11" in pyproject.toml to a version higher than 3.8 or 3.10. Note that this may vary depending on your specific situation.
4. Create and activate a virtual environment:

# Create a virtual environment and activate it
uv venv --python 3.11
source .venv/bin/activate

# Install mcp
uv add "mcp[cli]"

# Install dnspython (a dependency of external-recon.py, necessary for this project)
uv pip install dnspython

# Create the MCP server external-recon.py file or an empty file and rename it to main.py
touch external-recon.py

5. Modify VS Code settings:
   • Use which uv to find the path of uv.
   • "/path/to/project/external-recon" should be the absolute path to the project directory where the MCP server .py file is located (please use an absolute path).
   • Modify the settings.json file in VS Code as follows:

    "mcp": {
        "servers": {
                "external-recon": {
                 "command": "/path/to/uv",
                 "args": [
                  "--directory",
                  "/path/to/project/external-recon",
                  "run",
                  "external-recon.py"
                 ]
                }
        }
    },

💻 Usage Examples

Basic Usage

To start the server from the project's virtual environment, use the following command:

(external-recon) user@workstation external-recon % uv run external-recon.py

🔧 Technical Details

One of the main differences between Renae's work and mine is that I use @mcp.tool() instead of @mcp.prompt() in external-recon.py.