---
title: "Setup & Installation — AVCodex Docs"
description: "Setup & Installation — AVCodex documentation for AV integrators, programmers, and ops teams."
lang: en
json-ld:
---

[](/)

Solutions

[Pricing](/pricing)[The Signal](/blog)[Resources](/resources)

Learn

[Free AI Assessment](/scorecard)[Get Started →](/pricing)

[Documentation Home](/docs)

Guides 

Getting Started

-   [The Alchemist Copilot](/docs/guides/the-alchemist-copilot)
-   [Choosing a Model](/docs/guides/choosing-a-model)
-   [Skills & Templates](/docs/guides/skills-and-templates)
-   [Pricing & Usage](/docs/guides/pricing-and-usage)
-   [Understanding Tokens](/docs/guides/understanding-tokens)
-   [Maximize AVCodex Capabilities](/docs/guides/maximize-avcodex-capabilities)

Knowledge & Memory

-   [How Knowledge Sources Work](/docs/guides/how-knowledge-sources-work)
-   [Knowledge Retrieval Settings](/docs/guides/knowledge-retrieval-settings)
-   [User Memory](/docs/guides/user-memory)
-   [Consumer Brain](/docs/guides/consumer-brain)

Agent Capabilities

-   [Image Recognition](/docs/guides/image-recognition)
-   [Image Generation](/docs/guides/image-generation)
-   [Video Generation](/docs/guides/video-generation)
-   [Deep Research and Deep Thinking](/docs/guides/deep-research-and-deep-thinking)
-   [Heartbeat (Proactive AI Outreach)](/docs/guides/heartbeat-proactive-ai-outreach)
-   [Database Connections](/docs/guides/database-connections)
-   [Agent-to-Agent Links](/docs/guides/agent-to-agent-links)
-   [Message Tagging](/docs/guides/message-tagging)
-   [Lead Generation Forms](/docs/guides/lead-generation-forms)
-   [Multilingual Apps](/docs/guides/multilingual-apps)
-   [Understanding Evaluations](/docs/guides/understanding-evaluations)

Design & Experience

-   [Style Studio](/docs/guides/style-studio)
-   [Component Studio](/docs/guides/component-studio)
-   [HQ Profile](/docs/guides/hq-profile)
-   [Multiplayer Chat](/docs/guides/multiplayer-chat)
-   [Circles](/docs/guides/circles)
-   [Desktop Agent](/docs/guides/desktop-agent)

Voice & Phone

-   [Phone Numbers](/docs/guides/phone-numbers)
-   [Outbound Calling](/docs/guides/outbound-calling)
-   [Voice Cloning](/docs/guides/voice-cloning)

Publish & Share

-   [Embed Chat Widget](/docs/guides/embed-chat-widget)
-   [Custom Domains](/docs/guides/custom-domains)
-   [PWA Installation](/docs/guides/pwa-installation)
-   [AVCodex Sites](/docs/guides/avcodex-sites)
-   [Embed on Kajabi](/docs/guides/embed-on-kajabi)
-   [How to Use AVCodex with Claude Code](/docs/guides/how-to-use-avcodex-with-claude-code)

Monetization & Access

-   [Selling Access](/docs/guides/selling-access)
-   [Consumer Monetization](/docs/guides/consumer-monetization)
-   [Access Control](/docs/guides/access-control)
-   [Bring Your Own Auth](/docs/guides/bring-your-own-auth)
-   [Clever SSO for Schools](/docs/guides/clever-sso-for-schools)

Analytics & Operations

-   [Analytics & Chat History](/docs/guides/analytics-and-chat-history)
-   [Performance Dashboard](/docs/guides/performance-dashboard)
-   [Programmatic Usage Stats](/docs/guides/programmatic-usage-stats)
-   [Session Lifecycle Webhooks](/docs/guides/session-lifecycle-webhooks)
-   [Audit Logs](/docs/guides/audit-logs)

Teams & White-Label

-   [Team Management](/docs/guides/team-management)
-   [Enterprise Whitelabel](/docs/guides/enterprise-whitelabel)

Alchemist Platform

-   [Alchemist Tickets](/docs/guides/alchemist-tickets)
-   [Alchemist Getting Started](/docs/guides/alchemist-getting-started)
-   [Alchemist Working with Tickets](/docs/guides/alchemist-working-with-tickets)
-   [Alchemist Local Development](/docs/guides/alchemist-local-development)

Alchemist Operations

-   [Alchemist Environment Variables](/docs/guides/alchemist-environment-variables)
-   [Alchemist Deploys and Domains](/docs/guides/alchemist-deploys-and-domains)
-   [Alchemist Self-Healing](/docs/guides/alchemist-self-healing)

Alchemist API & Automation

-   [Alchemist API Keys](/docs/guides/alchemist-api-keys)
-   [Alchemist MCP Server](/docs/guides/alchemist-mcp-server)
-   [Alchemist Pipeline Configuration](/docs/guides/alchemist-pipeline-configuration)
-   [Alchemist Pipeline Permutations](/docs/guides/alchemist-pipeline-permutations)

Developer Platform

-   [Building Custom MCP Servers](/docs/guides/building-custom-mcp-servers)
-   [Consumer OAuth for Custom MCP Servers](/docs/guides/consumer-oauth-for-custom-mcp-servers)

AVCodex MCP Server

-   [Overview](/docs/guides/overview)
-   [MCP Reference](/docs/guides/mcp-reference)
-   [Setup & Installation](/docs/guides/setup-and-installation)
-   [Authentication](/docs/guides/authentication)
-   [Tools Reference](/docs/guides/tools-reference)
-   [Common Workflows](/docs/guides/common-workflows)
-   [Rate Limits](/docs/guides/rate-limits)

Custom Actions 

Pro Actions 

API 

Builder API 

Agentic Commerce (ACP) 

Integrations 

[Docs](/docs)/ Guides / AVCodex MCP Server 

# Setup & Installation

Last updated · MAR 2026 · [Read as Markdown](/docs/guides/setup-and-installation.md)

# Setup and Installation

Connect the AVCodex MCP Server to Claude Code, Cursor, or any MCP client.

* * *

This guide walks through connecting the AVCodex MCP Server to your preferred AI coding assistant. If you write Crestron SIMPL# Pro in VS Code, work in Cursor on Q-SYS Lua modules, or just live in Claude Code, you can drive AVCodex from your editor.

## [Prerequisites# ](#prerequisites)

-   **Builder plan or higher.** MCP access requires a paid subscription ([upgrade here](https://app.avcodex.com/plans)).
-   **AVCodex account.** Sign up at [app.avcodex.com](https://app.avcodex.com) if you haven't already.

## [Claude Code# ](#claude-code)

Claude Code has built-in MCP support. Add AVCodex to your configuration file.

### [Step 1: Open the configuration# ](#step-1-open-the-configuration)

The configuration file is located at `~/.claude.json` (your home directory).

bash 

```
# macOS/Linux
nano ~/.claude.json

# Or open with your preferred editor
code ~/.claude.json
```

### [Step 2: Add the server# ](#step-2-add-the-server)

Add the AVCodex server to the `mcpServers` section:

json 

```
{
  "mcpServers": {
    "avcodex": {
      "url": "https://app.avcodex.com/mcp",
      "transport": "streamable-http"
    }
  }
}
```

If you already have other MCP servers configured:

json 

```
{
  "mcpServers": {
    "existing-server": {
      "...": "..."
    },
    "avcodex": {
      "url": "https://app.avcodex.com/mcp",
      "transport": "streamable-http"
    }
  }
}
```

### [Step 3: Restart Claude Code# ](#step-3-restart-claude-code)

Close and reopen Claude Code for the changes to take effect.

### [Step 4: Authenticate# ](#step-4-authenticate)

The first time you use an AVCodex tool, Claude Code will:

1.  Open your browser to the AVCodex authorization page.
2.  Ask you to log in (if you aren't already).
3.  Show the permissions being requested.
4.  Return an authorization code to Claude Code.

After authorization, your tokens are stored securely and refreshed automatically.

### [Step 5: Verify the connection# ](#step-5-verify-the-connection)

Ask Claude to list your agents:

code 

```
List all my AVCodex agents
```

You should see a list of your agents. If you see an error, check the Troubleshooting section below.

* * *

## [Cursor# ](#cursor)

Cursor supports MCP through its settings panel.

### [Step 1: Open settings# ](#step-1-open-settings)

1.  Open Cursor.
2.  Go to **Settings** (Cmd/Ctrl + ,).
3.  Search for "MCP" or navigate to the MCP section.

### [Step 2: Add the server# ](#step-2-add-the-server)

Add a new MCP server with these settings:

Field

Value

Name

`avcodex`

URL

`https://app.avcodex.com/mcp`

Transport

`streamable-http`

Or add directly to your Cursor settings JSON:

json 

```
{
  "mcp": {
    "servers": {
      "avcodex": {
        "url": "https://app.avcodex.com/mcp",
        "transport": "streamable-http"
      }
    }
  }
}
```

### [Step 3: Authenticate# ](#step-3-authenticate)

When you first use AVCodex tools, Cursor will prompt you to authorize via your browser.

* * *

## [Generic MCP client# ](#generic-mcp-client)

For any MCP-compatible client, use these connection details.

### [Server configuration# ](#server-configuration)

json 

```
{
  "name": "avcodex",
  "url": "https://app.avcodex.com/mcp",
  "transport": "streamable-http"
}
```

### [OAuth discovery# ](#oauth-discovery)

The server supports OAuth discovery via:

code 

```
GET https://app.avcodex.com/.well-known/oauth-authorization-server
```

Response:

json 

```
{
  "issuer": "https://app.avcodex.com",
  "authorization_endpoint": "https://app.avcodex.com/mcp/oauth/authorize",
  "token_endpoint": "https://app.avcodex.com/mcp/oauth/token",
  "registration_endpoint": "https://app.avcodex.com/mcp/oauth/register",
  "revocation_endpoint": "https://app.avcodex.com/mcp/oauth/revoke",
  "response_types_supported": ["code"],
  "grant_types_supported": ["authorization_code", "refresh_token"],
  "code_challenge_methods_supported": ["S256"],
  "token_endpoint_auth_methods_supported": ["none"]
}
```

### [Manual OAuth flow# ](#manual-oauth-flow)

If your client doesn't support automatic OAuth, implement the flow manually:

1.  **Generate a PKCE challenge** (S256 method required).
2.  **Redirect to authorize**:

\`\` `https://app.avcodex.com/mcp/oauth/authorize? client_id=your_client_id &redirect_uri=your_callback_url &response_type=code &scope=* &code_challenge=YOUR_CHALLENGE &code_challenge_method=S256 &state=random_state` \`\`

1.  **Exchange the code for tokens**:

\`\`\`bash POST https://app.avcodex.com/mcp/oauth/token Content-Type: application/json

{ "grant\_type": "authorization\_code", "code": "AUTH\_CODE", "redirect\_uri": "your\_callback\_url", "client\_id": "your\_client\_id", "code\_verifier": "YOUR\_VERIFIER" } \`\`\`

1.  **Use the access token** in requests:

\`\` `Authorization: Bearer avcodex_at_xxxxx` \`\`

See the Authentication Guide for full details.

* * *

## [Alternative: API keys# ](#alternative-api-keys)

For automation and scripts, you can use API keys instead of OAuth.

1.  Go to **Settings, Developer, API Keys** in your AVCodex dashboard.
2.  Click **Create Key** and give it a name.
3.  Copy the key (shown only once).
4.  Use it in your requests:

json 

```
{
  "mcpServers": {
    "avcodex": {
      "url": "https://app.avcodex.com/mcp",
      "transport": "streamable-http",
      "headers": {
        "Authorization": "Bearer avcodex_sk_xxxxx"
      }
    }
  }
}
```

See the Authentication Guide for more on API key management.

* * *

## [Endpoints reference# ](#endpoints-reference)

Endpoint

Purpose

`https://app.avcodex.com/mcp`

Main MCP endpoint (POST JSON-RPC)

`https://app.avcodex.com/health`

Health check

`https://app.avcodex.com/.well-known/oauth-authorization-server`

OAuth discovery

`https://app.avcodex.com/mcp/oauth/authorize`

OAuth authorization

`https://app.avcodex.com/mcp/oauth/token`

Token exchange

`https://app.avcodex.com/mcp/oauth/register`

Dynamic client registration

`https://app.avcodex.com/mcp/oauth/revoke`

Token revocation

* * *

## [Troubleshooting# ](#troubleshooting)

### ["MCP server not found"# ](#mcp-server-not-found)

**Cause:** Configuration file not loaded or syntax error.

**Fix:**

1.  Verify JSON syntax (use a validator).
2.  Check the config file path is correct.
3.  Restart your MCP client.

### ["Authentication required"# ](#authentication-required)

**Cause:** No valid token, or token expired.

**Fix:**

1.  Trigger a tool call to start the OAuth flow.
2.  Complete authorization in the browser.
3.  If the flow fails, clear cached tokens and retry.

### ["Connection refused"# ](#connection-refused)

**Cause:** Network issue or URL typo.

**Fix:**

1.  Verify URL: `https://app.avcodex.com/mcp`.
2.  Check internet connection.
3.  Try the health endpoint: `curl https://app.avcodex.com/health`.

### ["Invalid scope"# ](#invalid-scope)

**Cause:** Requesting unauthorized permissions.

**Fix:**

1.  Use `scope=*` for all permissions, or
2.  Request only the scopes you need (e.g., `apps:read apps:write`).

### ["Rate limit exceeded"# ](#rate-limit-exceeded)

**Cause:** Too many requests for your subscription tier.

**Fix:**

1.  Wait for the reset time (check `Retry-After` header).
2.  Consider upgrading your plan for higher limits.
3.  See the Rate Limits Guide for best practices.

### [Clearing cached tokens# ](#clearing-cached-tokens)

If you need to re-authenticate:

**Claude Code:**

bash 

```
# Find and remove AVCodex tokens
rm -rf ~/.claude/mcp-tokens/avcodex*
```

**Cursor:**

-   Go to Settings, MCP, AVCodex, Remove/Reconnect.

* * *

## [Testing your connection# ](#testing-your-connection)

After setup, verify with these commands.

### [Basic test# ](#basic-test)

code 

```
"List my AVCodex agents"
```

Expected: a list of your agents with IDs and names.

### [Permission test# ](#permission-test)

code 

```
"Create a test agent called MCP-Test with a simple greeting prompt"
```

Expected: agent created successfully with an ID returned.

### [Cleanup# ](#cleanup)

code 

```
"Delete the agent named MCP-Test"
```

Expected: deletion confirmation.

> **Success:** If all three tests pass, you're ready to use the AVCodex MCP Server.

## [Next steps# ](#next-steps)

-   Authentication. Deep dive into OAuth and API keys.
-   Tools reference. Every available tool.
-   Common workflows. Step-by-step examples.

\*AVCodex · Your AV expertise. Amplified by AI.\*

Was this helpful? 

[Edit this page →](#)

[

Previous

MCP Reference

](/docs/guides/mcp-reference)[

Next

Authentication

](/docs/guides/authentication)

On this page

-   [Prerequisites](#prerequisites)
-   [Claude Code](#claude-code)
-   [Step 1: Open the configuration](#step-1-open-the-configuration)
-   [Step 2: Add the server](#step-2-add-the-server)
-   [Step 3: Restart Claude Code](#step-3-restart-claude-code)
-   [Step 4: Authenticate](#step-4-authenticate)
-   [Step 5: Verify the connection](#step-5-verify-the-connection)
-   [Cursor](#cursor)
-   [Step 1: Open settings](#step-1-open-settings)
-   [Step 2: Add the server](#step-2-add-the-server)
-   [Step 3: Authenticate](#step-3-authenticate)
-   [Generic MCP client](#generic-mcp-client)
-   [Server configuration](#server-configuration)
-   [OAuth discovery](#oauth-discovery)
-   [Manual OAuth flow](#manual-oauth-flow)
-   [Alternative: API keys](#alternative-api-keys)
-   [Endpoints reference](#endpoints-reference)
-   [Troubleshooting](#troubleshooting)
-   ["MCP server not found"](#mcp-server-not-found)
-   ["Authentication required"](#authentication-required)
-   ["Connection refused"](#connection-refused)
-   ["Invalid scope"](#invalid-scope)
-   ["Rate limit exceeded"](#rate-limit-exceeded)
-   [Clearing cached tokens](#clearing-cached-tokens)
-   [Testing your connection](#testing-your-connection)
-   [Basic test](#basic-test)
-   [Permission test](#permission-test)
-   [Cleanup](#cleanup)
-   [Next steps](#next-steps)

[](/)

The AI platform built exclusively for professional AV. Build, deploy, and sell AI tools that understand your industry.

### Platform

-   What You Can Build
-   Templates
-   [Pricing](/pricing)

### Services

-   [Done-For-You](/pricing)
-   [Academy](/academy)
-   [Contact](/contact)

### Company

-   About
-   [The Signal](/blog)
-   [Docs](/docs)
-   [LinkedIn](#)

© 2026 AVCodex. A Future Ready Holdings Inc. product. SOC 2 Type II Certified · HIPAA Compliant