# AgentQL MCP Server
<!-- mcp-name: com.mcparmory/agentql -->

Base URL: https://api.agentql.com
| | |
|---|---|
| **Category** | Developer Tools |
| **Tools** | 3 |
| **Auth** | API Key |

---

## Install

### Quick Start (recommended)

```bash
API_KEY=YOUR_API_KEY \
uvx mcparmory-agentql
```

### With pip

```bash
pip install mcparmory-agentql
API_KEY=YOUR_API_KEY \
mcparmory-agentql
```

### MCP Client Configuration

Add to your MCP client config (e.g. Claude Desktop, Cursor, Codex):

```json
{
  "mcpServers": {
    "agentql": {
      "command": "uvx",
      "args": ["mcparmory-agentql"],
      "env": {
        "API_KEY": "YOUR_API_KEY"
      }
    }
  }
}
```

---

## Credentials

Set the following environment variables (via MCP client `env` config, shell export, or `.env` file):

- `API_KEY` — API Key Authentication (X-API-Key)

Do not commit credentials to version control.

---

## Run Locally

**First**, configure your credentials in `.env` (see [Credentials](#credentials) above).

```bash
pip install -r requirements.txt
python server.py
```

## Connect MCP Client

Edit `.mcp.json` and replace `<SERVER_DIR>` with the absolute path to this directory, then add to your MCP client configuration.

Example (if server is at `/home/user/mcp-servers/agentql`):
```json
{
  "mcpServers": {
    "agentql": {
      "command": "python",
      "args": ["/home/user/mcp-servers/agentql/server.py"]
    }
  }
}
```

---

## Docker

### Pre-built image (recommended)

```bash
docker run -p 8000:8000 \
  -e API_KEY=YOUR_API_KEY \
  ghcr.io/mcparmory/agentql:latest
```

### Build from source

**First**, configure your credentials in `.env` (see [Credentials](#credentials) above).

```bash
docker build -t agentql .
docker run -p 8000:8000 --env-file .env agentql
```

**Before running**, make sure ports 8000 are free.### MCP client config (Docker)

For Docker, use SSE transport in your MCP client config:
```json
{
  "mcpServers": {
    "agentql": {
      "type": "sse",
      "url": "http://localhost:8000/sse"
    }
  }
}
```

---

## Files

- `.env` - Credentials and server configuration
- `.mcp.json` - MCP client config template
- `Dockerfile` - Container build
- `LICENSE` - MIT license for this generated code
- `requirements.txt` - Python dependencies
- `README.md` - This file
- `server.py` - MCP server entry point
- `_auth.py` - Authentication handlers
- `_models.py` - Request/response models
- `_validators.py` - Input validation

**Note:** Files starting with `.` are hidden by default on macOS/Linux. Use `ls -a` in terminal or enable "Show hidden files" in your file manager to see `.env` and `.mcp.json`.

---

<p align="center">
  <a href="https://mcpblacksmith.com"><img src="https://wjxawmrpsfuivlicnepc.supabase.co/storage/v1/object/public/newsletter/logo-blacksmith.png" alt="MCP Blacksmith" height="48"></a>
  <br>
  <sub>Generated by <a href="https://mcpblacksmith.com">MCP Blacksmith</a> · <a href="https://docs.mcpblacksmith.com/quickstart">Quickstart docs</a> · <a href="mailto:contact@mcpblacksmith.com">Report a bug</a></sub>
</p>