beginner⏱️ 15-25 minutes📅 Updated June 2026

Step-by-step guide to integrate APIWeaver MCP server with Amazon Q CLI. Includes dynamic api registration and multi-protocol support.

APIWeaver + Amazon Q CLI: 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 Amazon Q CLI, 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 Amazon Q CLI, 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 Amazon Q CLI
  • All APIWeaver capabilities will be available for your workflows
  • Access to 6 different tools

Prerequisites

Before starting, ensure you have:

  • Amazon Q CLI installed and configured
  • Compatible operating system (Windows, macOS, Linux)

Installation

Step 1: Install APIWeaver

Configuration

Step 2: Configure Amazon Q CLI

  1. Install Amazon Q CLI

Download and install Q CLI for your platform

Visit: https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-installing.html

  1. Authenticate

Set up authentication with AWS Builder ID or IAM Identity Center

q auth

Note: Follow interactive authentication flow

  1. Verify Installation

Test Q CLI installation and configuration

q doctor
  1. Install MCP Server

Install the MCP server you want to integrate

Note: Ensure server is accessible from command line

  1. Configure MCP Integration

Add MCP server configuration to Q CLI

Note: Use q config commands to set server parameters

  1. Test Integration

Verify MCP server works with Q CLI

q chat "Use APIWeaver to help me"

Configuration Details

Configure MCP servers through Q CLI commands:

# Configure MCP server integration
q config set mcp.servers.apiweaver.command "apiweaver"
q config set mcp.servers.apiweaver.args ""
q config set mcp.servers.apiweaver.env ""

# Verify configuration
q config list mcp.servers

Examples

Once configured, you can use APIWeaver in Amazon Q CLI:

Register REST API with Authentication

Add a REST API with Bearer token authentication

Ask Amazon Q CLI: "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 Amazon Q CLI: "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 Amazon Q CLI: "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 Amazon Q CLI: "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

  1. Run q doctor to verify system health
  2. Start Q CLI chat session
  3. Ask Q to list available MCP tools
  4. Test specific APIWeaver functionality

Test commands:

q doctor

q chat

q config list mcp.servers

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

Installation Failed

Symptoms: Q command not found, Installation errors

Cause: Incomplete installation or PATH issues

Solution:

  • Verify installer completed successfully
  • Check PATH environment variable includes Q CLI
  • Try running q doctor for diagnostics
  • Reinstall using platform-specific method

Authentication Problems

Symptoms: Auth errors, Cannot connect to AWS services

Cause: Invalid credentials or network issues

Solution:

  • Run q auth to re-authenticate
  • Verify AWS Builder ID or IAM credentials
  • Check network connectivity to AWS
  • Ensure proper AWS permissions are set

MCP Server Not Found

Symptoms: Server command not found, MCP tools unavailable

Cause: Server not installed or not in PATH

Solution:

  • Verify MCP server installation
  • Check server executable permissions
  • Use absolute path in configuration
  • Test server independently with direct command

Configuration Errors

Symptoms: Config commands fail, Settings not persisting

Cause: Invalid configuration syntax or permissions

Solution:

  • Check Q CLI configuration file permissions
  • Verify configuration syntax is correct
  • Use q config list to review current settings
  • Report issues with q issue command

APIWeaver not appearing in Amazon Q CLI

Symptoms: Server not listed, Tools not available

Cause: Configuration or installation issue

Solution:

  • Verify configuration syntax
  • Check APIWeaver installation
  • Restart Amazon Q CLI
  • Check logs for error messages

Next Steps

Now that APIWeaver is integrated with Amazon Q CLI:

  • Explore all APIWeaver capabilities through Amazon Q CLI
  • Check out other MCP servers that work with Amazon Q CLI
  • Join the MCP community for tips and support
  • Consider contributing to APIWeaver development

Need Help?

Related Resources

More Integrations

Explore other MCP servers that work with Amazon Q CLI

Need Help?

Join the MCP community for support and discussions

APIWeaver + Amazon Q CLI: MCP Setup Guide (2026)