Peacock MCP

🚀 How to Run the Peacock MCP Server Based on VS Code

If you have enabled the MCP server powered by Claude Desktop, add "chat.mcp.discovery.enabled": true to your VS Code settings. This will allow it to discover the existing list of MCP servers.

Associating the MCP Server with a Specific Repository

If you want to associate the MCP server with a specific repository, create a .vscode/mcp.json file in the repository directory and add the following content:

{
  "inputs": [],
  "servers": {
    "peacock-mcp": {
      "command": "npx",
      // "command": "node",
      "args": [
        "-y",
        "@johnpapa/peacock-mcp"
        // "_git/peacock-mcp/dist/index.js"
      ],
      "env": {}
    }
  }
}

Associating the MCP Server with All Repositories

If you want to associate the MCP server with all repositories, add the following content to your VS Code user settings JSON:

{
  "mcp": {
    "servers": {
      "peacock-mcp": {
        "command": "npx",
        // "command": "node",
        "args": [
          "-y",
          "@johnpapa/peacock-mcp"
          // "/Users/papa/_git/peacock-mcp/dist/index.js"
          // "_git/peacock-mcp/dist/index.js"
        ],
        "env": {}
      }
    }
  },
  "chat.mcp.discovery.enabled": true
}

🚀 Quick Start

Manual Installation in VS Code

⚠️ Important Note

If you want a quick installation, click the installation button at the top of this README.

Using VS Code Settings

To manually install the Peacock MCP server in VS Code, follow these steps:

1. Open VS Code settings (JSON): Press Cmd+Shift+P (macOS) or Ctrl+Shift+P (Windows/Linux), and search for "Preferences: Open User Settings (JSON)".
2. Add the following JSON to your settings file:

{
  "mcp": {
    "servers": {
      "peacock-mcp": {
        "command": "npx",
        "args": ["-y", "@johnpapa/peacock-mcp"],
        "env": {}
      }
    }
  },
  "chat.mcp.discovery.enabled": true
}

Using CLI Commands

For the stable version of VS Code:

code --add-mcp '{"name":"peacock-mcp","command":"npx","args":["-y","@johnpapa/peacock-mcp"],"env":{}}'

For the VS Code Insiders version:

code-insiders --add-mcp '{"name":"peacock-mcp","command":"npx","args":["-y","@johnpapa/peacock-mcp"],"env":{}}'

Installation via Smithery

To automatically install the Peacock MCP server for use with Claude Desktop via Smithery, run the following command:

npx -y @smithery/cli install @johnpapa/peacock-mcp --client claude

Local Testing with MCP Inspector

If you want to run the server locally for testing using MCP Inspector, follow these steps:

1. Clone this repository:

   git clone https://github.com/johnpapa/peacock-mcp
   

2. Install the required dependencies and build the project.

   npm install
   npm run build
   

3. (Optional) To try running the server with MCP Inspector, run the following command:

   # Start MCP Inspector
   npx @modelcontextprotocol/inspector node build/index.js
   

   Access the MCP Inspector URL displayed in the console in your browser. Change Arguments to dist/index.js, then select Connect. Select List Tools to view all available tools.

💻 Using Tools in GitHub Copilot

1. Now that the MCP server is discoverable, open GitHub Copilot and select Agent mode (not Chat or Edits).

2. In the Copilot chat text field, select the "Refresh" button to refresh the server list.

3. Select the "🛠️" button to view all possible tools, including those from this repository.

4. Ask a question that will naturally invoke one of the tools, for example:

   How do I set the color of my VS Code color palette?
   

   ⚠️ Important Note

   If you see "Sorry, the response was filtered by a responsible AI service. Please rephrase and try again.", run the command again or rephrase the question.

By following these steps, you can successfully run the Peacock MCP server in VS Code and use its features in GitHub Copilot.