> ## Documentation Index
> Fetch the complete documentation index at: https://docs.codealive.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Amazon Q Developer

> Connect CodeAlive with Amazon Q Developer CLI and IDE

## Overview

Connect CodeAlive with Amazon Q Developer for AI-powered development with deep codebase understanding. Amazon Q has two integration points: the CLI and the IDE plugin (VS Code / JetBrains).

> [!TIP]
>
> **Quick install:** Run `npx @codealive/installer` to automatically configure CodeAlive for your agents.
> See the [Installation Guide](https://docs.codealive.ai/installation.md) for details.

## Prerequisites

* Amazon Q Developer CLI or IDE plugin
* CodeAlive account with API key ([Sign up here](https://app.codealive.ai))
* Indexed repositories in your CodeAlive dashboard

## Setup

> [tab] Q Developer CLI
>
> **1. Locate Config File**
>
> Amazon Q CLI reads MCP configuration from:
>
> * **Global:** `~/.aws/amazonq/mcp.json`
> * **Workspace:** `.amazonq/mcp.json`
>
> **2. Add CodeAlive Server**
>
> > [tab] HTTP (Recommended)
> >
> > ```json theme={null}
> > {
> >   "mcpServers": {
> >     "codealive": {
> >       "type": "http",
> >       "url": "https://mcp.codealive.ai/api",
> >       "headers": {
> >         "Authorization": "Bearer YOUR_API_KEY_HERE"
> >       }
> >     }
> >   }
> > }
> > ```
>
> > [tab] Docker (STDIO)
> >
> > ```json theme={null}
> > {
> >   "mcpServers": {
> >     "codealive": {
> >       "type": "stdio",
> >       "command": "docker",
> >       "args": [
> >         "run", "--rm", "-i",
> >         "-e", "CODEALIVE_API_KEY=YOUR_API_KEY_HERE",
> >         "ghcr.io/codealive-ai/codealive-mcp:main"
> >       ]
> >     }
> >   }
> > }
> > ```
>
> Replace `YOUR_API_KEY_HERE` with your actual CodeAlive API key.
>
> **3. Restart Q Developer CLI**
>
> Restart the CLI to pick up the new configuration.

> [tab] Q Developer IDE (VS Code / JetBrains)
>
> **1. Locate Config File**
>
> Amazon Q IDE plugin reads from:
>
> * **Global:** `~/.aws/amazonq/agents/default.json`
> * **Workspace:** `.aws/amazonq/agents/default.json`
>
> **2. Add CodeAlive Server**
>
> ```json theme={null}
> {
>   "mcpServers": {
>     "codealive": {
>       "type": "http",
>       "url": "https://mcp.codealive.ai/api",
>       "headers": {
>         "Authorization": "Bearer YOUR_API_KEY_HERE"
>       },
>       "timeout": 310000
>     }
>   }
> }
> ```
>
> Replace `YOUR_API_KEY_HERE` with your actual CodeAlive API key.
>
> Or use the IDE UI: **Q panel → Chat → tools icon → Add MCP Server** → choose HTTP or STDIO.
>
> **3. Restart IDE**
>
> Restart VS Code or your JetBrains IDE to load the configuration.

## Usage

Once connected, Amazon Q Developer can:

* **Search your codebase** semantically across all indexed repositories
* **Answer architecture questions** with full project context
* **Find patterns and implementations** across multiple services

```
"Find all API endpoints in the user service"
"Explain how the payment flow works"
"Show me error handling patterns"
```

## Troubleshooting

> [accordion] MCP server not detected
>
> 1. Verify the config file location matches your setup (CLI vs IDE)
> 2. Check JSON syntax
> 3. Restart the CLI or IDE

> [accordion] Authentication errors
>
> 1. Verify your API key is correct
> 2. Ensure `Bearer ` prefix is included in the Authorization header
> 3. Try regenerating your API key in the [dashboard](https://app.codealive.ai)

> [accordion] IDE UI setup not persisting
>
> Use the config file method instead of the UI for reliable persistence.

> [!TIP]
>
> For more solutions, see the [Troubleshooting Guide](https://docs.codealive.ai/troubleshooting.md).

## Related Resources

* [MCP Overview](https://docs.codealive.ai/integrations/mcp.md)
* [Installation Guide](https://docs.codealive.ai/installation.md)
* [Self-Hosting Guide](https://docs.codealive.ai/integrations/mcp/self-hosting.md)
* [Agent Skills](https://docs.codealive.ai/integrations/skills.md)

## Instruct Your Agent

Connecting CodeAlive makes its tools available, but the agent may still default to its built-in search. For reliable results, add a short instruction in the agent's native format telling it to prefer `semantic_search` and `grep_search` when exploring indexed code. See [Instructing Coding Agents](https://docs.codealive.ai/guides/instructing-agents.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.