APIWeaver + GitHub Copilot (VS Code): Complete MCP Integration
APIWeaver is a MCP server that An MCP server that dynamically creates MCP servers from web API configurations. This allows you to easily integrate any REST API, GraphQL endpoint, or web service into an MCP-compatible tool that can be used by AI assistants like Claude..
When integrated with GitHub Copilot (VS Code), you can:
- Register and configure APIs at runtime without server restart
- Support for REST APIs, GraphQL endpoints, and web services
- Multiple authentication methods for different API requirements
This guide provides step-by-step instructions to set up APIWeaver in GitHub Copilot (VS Code), including configuration, examples, and troubleshooting.
What You'll Achieve
After completing this setup:
- APIWeaver will be fully integrated and operational
- You can use APIWeaver tools directly in GitHub Copilot (VS Code)
- All APIWeaver capabilities will be available for your workflows
- Access to 6 different tools
Prerequisites
Before starting, ensure you have:
- GitHub Copilot (VS Code) installed and configured
- Compatible operating system (Windows, macOS, Linux)
Installation
Step 1: Install APIWeaver
Configuration
Step 2: Configure GitHub Copilot (VS Code)
-
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
- Windows:
-
Add server configuration:
{
"mcpServers": {
"apiweaver": {
"command": "apiweaver",
"args": [],
"env": {
}
}
}
}
- Restart GitHub Copilot (VS Code)
Completely quit and restart GitHub Copilot (VS Code) to load the new configuration.
Examples
Once configured, you can use APIWeaver in GitHub Copilot (VS Code):
Register REST API with Authentication
Add a REST API with Bearer token authentication
Ask GitHub Copilot (VS Code): "Register the JSONPlaceholder API (https://jsonplaceholder.typicode.com) with GET and POST methods"
Expected Result: API registered successfully with auto-generated tools for posts, users, and comments endpoints
GraphQL Endpoint Integration
Connect to a GraphQL API for data querying
Ask GitHub Copilot (VS Code): "Register the GitHub GraphQL API with authentication and create tools for repository queries"
Expected Result: GraphQL endpoint configured with query tools for repositories, issues, and user data
API Testing and Validation
Test API connectivity before integration
Ask GitHub Copilot (VS Code): "Test connection to the Stripe API with my API key before registering it"
Expected Result: Connection test successful with API schema validation and endpoint verification
Multi-API Workflow
Integrate multiple APIs for complex workflows
Ask GitHub Copilot (VS Code): "Register both Twitter API and SendGrid API to create a workflow for social media monitoring and email alerts"
Expected Result: Both APIs registered with tools for tweet monitoring, email sending, and automated workflow execution
Testing Your Setup
- Start a new conversation in GitHub Copilot (VS Code)
- Ask GitHub Copilot (VS Code) to list available tools
- Try using APIWeaver functionality
Test prompts:
- "What MCP tools are available?"
- "Use APIWeaver to help with my code"
- "Show me what APIWeaver can do"
Troubleshooting
Common Issues
API Registration Failed
Symptoms: Registration errors, Invalid API configuration, Connection timeouts
Cause: Incorrect API URL, authentication issues, or network problems
Solution:
- Verify API endpoint URL is accessible
- Check authentication credentials are valid
- Test API manually with curl or Postman first
- Ensure network connectivity and firewall settings
Authentication Not Working
Symptoms: 401 Unauthorized, 403 Forbidden, Auth token invalid
Cause: Incorrect authentication method or invalid credentials
Solution:
- Verify authentication method matches API requirements
- Check API key/token is not expired
- Confirm header format and parameter names
- Test authentication with API documentation examples
Transport Mode Not Connecting
Symptoms: Connection refused, Transport errors, Client not recognizing server
Cause: Incorrect transport configuration or port conflicts
Solution:
- Use streamable-http for modern clients
- Check port is not in use: netstat -an | grep :8000
- Verify host/port settings match client configuration
- Try different transport modes (stdio/http/sse)
Python Dependencies Missing
Symptoms: Import errors, Module not found, Package installation failures
Cause: Missing Python packages or virtual environment issues
Solution:
- Install requirements: pip install -r requirements.txt
- Create virtual environment: python -m venv apiweaver-env
- Activate environment before installation
- Upgrade pip: python -m pip install --upgrade pip
API Schema Generation Failed
Symptoms: Tool generation errors, Schema parsing failures, Endpoint mapping issues
Cause: Unsupported API format or incomplete API documentation
Solution:
- Provide OpenAPI/Swagger specification if available
- Start with simple GET endpoints first
- Manually configure complex APIs step by step
- Check API documentation for required parameters
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
APIWeaver not appearing in GitHub Copilot (VS Code)
Symptoms: Server not listed, Tools not available
Cause: Configuration or installation issue
Solution:
- Verify configuration syntax
- Check APIWeaver installation
- Restart GitHub Copilot (VS Code)
- Check logs for error messages
Next Steps
Now that APIWeaver is integrated with GitHub Copilot (VS Code):
- Explore all APIWeaver 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 APIWeaver development
Need Help?
- Search for APIWeaver documentation
- Check the GitHub Copilot (VS Code) MCP guide
- Join the MCP community discussions