Apache Pinot + GitHub Copilot (VS Code): Complete MCP Integration

Apache Pinot is a MCP server that MCP server for Apache Pinot real-time analytics database with SQL query capabilities and metadata access.

When integrated with GitHub Copilot (VS Code), you can:

• List and inspect Apache Pinot tables
• View and analyze table segments
• Retrieve and analyze table schemas

This guide provides step-by-step instructions to set up Apache Pinot in GitHub Copilot (VS Code), including configuration, examples, and troubleshooting.

What You'll Achieve

After completing this setup:

• Apache Pinot will be fully integrated and operational
• You can use Apache Pinot tools directly in GitHub Copilot (VS Code)
• All Apache Pinot capabilities will be available for your workflows
• Access to 5 different tools

Prerequisites

Before starting, ensure you have:

• Apache Pinot broker hostname
• Apache Pinot broker port
• GitHub Copilot (VS Code) installed and configured
• Compatible operating system (Windows, macOS, Linux)

Installation

Step 1: Install Apache Pinot

Configuration

Step 2: Configure GitHub Copilot (VS Code)

1. Locate your configuration file:

   • Windows: .vscode\\mcp.json in your project directory
   • macOS: .vscode/mcp.json in your project directory
   • Linux: .vscode/mcp.json in your project directory

2. Add server configuration:

{
  "mcpServers": {
    "apache-pinot": {
      "command": "apache pinot",
      "args": ["/path/to/mcp-pinot-repo"],
      "env": {
        "PINOT_BROKER_HOST": "localhost",
        "PINOT_BROKER_PORT": "9000"
      }
    }
  }
}

3. Restart GitHub Copilot (VS Code)

Completely quit and restart GitHub Copilot (VS Code) to load the new configuration.

Examples

Once configured, you can use Apache Pinot in GitHub Copilot (VS Code):

List All Tables

Get overview of available Pinot tables

Ask GitHub Copilot (VS Code): "Show me all the tables available in the Pinot cluster"

Expected Result: List of table names with basic metadata and schema information

Execute Analytics Query

Run SQL query for real-time analytics

Ask GitHub Copilot (VS Code): "SELECT COUNT(*) FROM events WHERE timestamp > now() - 3600000"

Expected Result: Query results showing event count for last hour

Analyze Table Structure

Get detailed schema information for a table

Ask GitHub Copilot (VS Code): "Show me the schema and structure of the user_events table"

Expected Result: Table schema with column names, types, and index information

Generate Data Visualization

Create histogram plots from query results

Ask GitHub Copilot (VS Code): "Create a histogram showing user activity distribution by hour"

Expected Result: Histogram visualization with data aggregated by time buckets

Testing Your Setup

1. Start a new conversation in GitHub Copilot (VS Code)
2. Ask GitHub Copilot (VS Code) to list available tools
3. Try using Apache Pinot functionality

Test prompts:

• "What MCP tools are available?"
• "Use Apache Pinot to help with my code"
• "Show me what Apache Pinot can do"

Troubleshooting

Common Issues

uv Command Not Found

Symptoms: Command not found error, uv: command not found

Cause: uv package manager not installed

Solution:

• Install uv using: curl -LsSf https://astral.sh/uv/install.sh | sh
• Restart terminal or source shell configuration
• Verify installation with: uv --version

Pinot Connection Failed

Symptoms: Connection refused, Broker unreachable, Network timeout

Cause: Invalid Pinot broker configuration or cluster not running

Solution:

• Verify PINOT_BROKER_HOST and PINOT_BROKER_PORT in .env file
• Check Pinot cluster is running and accessible
• Test connection: telnet <broker_host> <broker_port>
• Ensure firewall allows connections to Pinot broker

Environment Variables Not Loaded

Symptoms: Config missing errors, Default values being used

Cause: .env file not found or incorrectly formatted

Solution:

• Create .env file in repository root directory
• Copy from .env.example and modify values
• Ensure no spaces around = in variable assignments
• Restart MCP server after configuration changes

Claude Desktop Not Recognizing Server

Symptoms: Server not appearing, Connection errors in Claude

Cause: Incorrect claude_desktop_config.json configuration

Solution:

• Verify path to uv binary in command field
• Ensure correct path to mcp-pinot repository
• Restart Claude Desktop after configuration changes
• Check Claude Desktop logs for error messages

MCP Configuration Not Loaded

Symptoms: MCP tools not appearing, Copilot does not recognize MCP server

Cause: Configuration file not in correct location or invalid JSON

Solution:

• Verify .vscode/mcp.json exists in project root directory
• Check JSON syntax is valid (no trailing commas, proper quotes)
• Reload VS Code window after making configuration changes
• Check VS Code Developer Tools (Help > Toggle Developer Tools) for errors

MCP Server Not Starting

Symptoms: Tools listed but not responding, Server connection errors

Cause: Server command path incorrect or dependencies missing

Solution:

• Test the MCP server command independently in terminal
• Verify all server prerequisites are installed
• Check that command path is correct (use absolute paths if needed)
• Ensure required environment variables are set in mcp.json
• Review VS Code Output panel for MCP server error messages

GitHub Copilot Subscription Required

Symptoms: Copilot features grayed out, Unable to access Copilot Chat

Cause: No active GitHub Copilot subscription

Solution:

• Sign up for GitHub Copilot subscription (Individual, Business, or Enterprise)
• Verify subscription is active in GitHub account settings
• Re-authenticate GitHub Copilot in VS Code
• Check that VS Code is using correct GitHub account

VS Code Version Too Old

Symptoms: MCP configuration ignored, No mcp.json recognition

Cause: VS Code version below 1.99 does not have native MCP support

Solution:

• Update VS Code to version 1.99 or later
• Check current version: Help > About
• Download latest version from code.visualstudio.com
• After updating, reload window and verify MCP support

{server_name} Tools Not Working

Symptoms: Server connected but tools fail, Error messages when invoking tools

Cause: Server-specific configuration or authentication issues

Solution:

• Verify all required environment variables for {server_name} are set
• Check {server_name} documentation for specific prerequisites
• Test {server_name} with another MCP client to isolate issue
• Review error messages in VS Code Output panel for specific failures

Apache Pinot not appearing in GitHub Copilot (VS Code)

Symptoms: Server not listed, Tools not available

Cause: Configuration or installation issue

Solution:

• Verify configuration syntax
• Check Apache Pinot installation
• Restart GitHub Copilot (VS Code)
• Check logs for error messages

Next Steps

Now that Apache Pinot is integrated with GitHub Copilot (VS Code):

• Explore all Apache Pinot capabilities through GitHub Copilot (VS Code)
• Check out other MCP servers that work with GitHub Copilot (VS Code)
• Join the MCP community for tips and support
• Consider contributing to Apache Pinot development

Need Help?

• Search for Apache Pinot documentation
• Check the GitHub Copilot (VS Code) MCP guide
• Join the MCP community discussions