> For the complete documentation index, see [llms.txt](https://docs.corraldata.com/kb/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.corraldata.com/kb/mcp/getting-started.md).

# Getting Started

Once connected, you can ask your AI assistant things like "What were our top locations by revenue last month?" or "Build me a dashboard comparing provider performance across locations" — and it will pull directly from your CorralData account to answer.

***

## Choose Your Setup

* [**Connecting to Claude**](#connecting-to-claude)
* [**Connecting to ChatGPT**](#connecting-to-chatgpt)
* [**Connecting to Claude Code**](#connecting-to-claude-code)
* [**Connecting to Codex**](#connecting-to-codex)

All setups use the same connection details:

| Field           | Value                            |
| --------------- | -------------------------------- |
| MCP Server URL  | `https://mcp.corraldata.com/mcp` |
| OAuth Client ID | `corral-mcp-client`              |

{% hint style="info" %}
**No client secret is needed.** CorralData uses a public OAuth client with PKCE. If a form insists on a client secret, enter any value — it is not checked. Your CorralData login is what controls access to your data.
{% endhint %}

***

## Connecting to Claude

You'll add CorralData directly inside Claude.ai or the Claude Desktop app.

#### Team and Enterprise plans

{% hint style="info" %}
On Team and Enterprise plans, a **Claude admin** enables CorralData for the organization first. Then each **member** connects with their own CorralData login.
{% endhint %}

**For Admins:**

{% stepper %}
{% step %}
**Open your Claude Organization Settings**

Click your organization name and select **Settings**.
{% endstep %}

{% step %}
**Go to Connectors**

In the left sidebar, click **Connectors**. Or, [click here](https://claude.ai/settings/connectors?modal=add-custom-connector) to go there directly.
{% endstep %}

{% step %}
**Search for CorralData**

Type it into the search field, then click on the listing.
{% endstep %}

{% step %}
**Click 'Connect to Claude' Button**
{% endstep %}

{% step %}
**Sign into your CorralData Account**

Sign in with your CorralData credentials on the page that opens. You'll be redirected back to Claude once you login successfully and the connector will show **Connected.**

{% hint style="success" %}
**You're done!** CorralData will be available in Claude conversations. Claude will have access to all accounts your login can view. If your login has access to more than one account, confirm with Claude which one you're working in before running queries or creating widgets.<br>

See what you can do [after you connect](#after-you-connect) or explore more [usage examples.](/kb/mcp/usage-examples.md) We also recommend installing the [CorralData skill](#add-the-corraldata-skill-recommended) after you've connected.
{% endhint %}
{% endstep %}
{% endstepper %}

**For Members:**

The steps are the same as the [Personal plan steps](#personal-plans-pro-max). You may see **Request** instead of Connect in step 3 if CorralData hasn't been added as an organization connector yet by an admin. Click it to send the request to your Claude admin. Once they approve it and enabled the connector, you will be able to connect.

#### Personal plans (Pro, Max)

{% stepper %}
{% step %}
**Go to Customize and select Connectors**

In the left sidebar, click **Customize**, then the **Connectors** tab. Or, [click here](https://claude.ai/customize/connectors) to go there direcly.
{% endstep %}

{% step %}
**Search for CorralData**

Type it into the search field, then click on the listing.
{% endstep %}

{% step %}
**Click 'Connect to Claude' Button**
{% endstep %}

{% step %}
**Sign into your CorralData Account**

Sign in with your CorralData credentials on the page that opens. You'll be redirected back to Claude once you login successfully and the connector will show **Connected.**

{% hint style="success" %}
**You're done!** CorralData will be available in Claude conversations. Claude will have access to all accounts your login can view. If your login has access to more than one account, confirm with Claude which one you're working in before running queries or creating widgets.\
\
See what you can do [after you connect](#after-you-connect) or explore more [usage examples.](/kb/mcp/usage-examples.md) We also recommend installing the [CorralData skill](#add-the-corraldata-skill-recommended) after you've connected.
{% endhint %}
{% endstep %}
{% endstepper %}

### Add the CorralData skill (recommended)

The connector gives Claude access to your data. The CorralData skill teaches Claude how to use it well: how to explore your schemas, write correct SQL, and read your boards and widgets. Installing it leads to faster, more accurate answers with less back-and-forth. It is optional, and only available on Claude clients that support skills.

**To install it: Download the file below**, then in Claude go to **Customize**, then **Skills,** and click **+Add** and choose **Upload skill**. Select the downloaded file. Claude applies it automatically whenever a conversation involves your CorralData data.

{% file src="/files/BFmqUXvOAEeTgQbjB76J" %}

***

## Connecting to ChatGPT

You'll add CorralData directly inside the ChatGPT web app.

{% hint style="info" %}
You'll need a **paid ChatGPT subscription** (Plus, Pro, or Team) to use custom MCP connectors.
{% endhint %}

{% stepper %}
{% step %}
**Enable Developer Mode**

Log in to [ChatGPT](https://chatgpt.com/), click your profile name in the left sidebar, and select **Settings**. Navigate to **Connectors**, then **Advanced Settings**, and toggle on **Developer mode**.
{% endstep %}

{% step %}
**Create a new connector**

Return to **Connectors**. You should now see a **Create** button — click it.
{% endstep %}

{% step %}
**Fill in the connection details**

Enter the following values exactly as shown:

| Field               | Value                            |
| ------------------- | -------------------------------- |
| Name                | CorralData                       |
| MCP Server URL      | `https://mcp.corraldata.com/mcp` |
| Authentication      | OAuth                            |
| OAuth Client ID     | `corral-mcp-client`              |
| OAuth Client Secret | *(leave empty)*                  |
| {% endstep %}       |                                  |

{% step %}
**Authorize**

Check the **I trust this application** checkbox and click **Create**. Complete the OAuth consent screen by selecting your organization and clicking **Allow**.

CorralData will now appear in your connectors list.
{% endstep %}

{% step %}
**Enable CorralData in chat**

Open a new chat. Click the **+** icon in the message bar, then **More → Developer Mode → Add Sources**, and toggle on CorralData.

You'll need to do this step each time you start a new chat where you want to use CorralData.

{% hint style="success" %}
**You're done!** CorralData will be available once enabled in a chat. Remember to turn it on at the start of each new conversation (Step 5 above). ChatGPT will have access to all accounts your login can view. If your login has access to more than one account, confirm with ChatGPT which one you're working in before running queries or creating widgets.\
\
See what you can do [after you connect](#after-you-connect) or explore more [usage examples.](/kb/mcp/usage-examples.md)
{% endhint %}
{% endstep %}
{% endstepper %}

***

## Connecting to Claude Code

{% hint style="info" %}
If you sign in to Claude Code with your **Claude.ai account** and your organization has already added the CorralData connector (see [Connecting to Claude](#connecting-to-claude)), it is available in Claude Code automatically. Nothing else to do.
{% endhint %}

If you use Claude Code with a **direct API key**, add the server yourself:

{% stepper %}
{% step %}
**Add the server**

Run in your terminal:

```bash
claude mcp add --transport http corraldata https://mcp.corraldata.com/mcp \
  --client-id corral-mcp-client
```

Add `--scope user` to make it available in every project.
{% endstep %}

{% step %}
**Log in**

Start Claude Code, run `/mcp`, select **corraldata**, and complete the CorralData login in the browser window that opens.
{% endstep %}
{% endstepper %}

***

## Connecting to Codex

{% stepper %}
{% step %}
**Add the server to your Codex config**

Open `~/.codex/config.toml` and add:

```toml
[mcp_servers.corraldata]
url = "https://mcp.corraldata.com/mcp"

[mcp_servers.corraldata.oauth]
client_id = "corral-mcp-client"
```

No client secret and no callback port are needed. Make sure Codex is up to date; older versions do not support the `oauth` section.
{% endstep %}

{% step %}
**Log in**

Run in your terminal:

```bash
codex mcp login corraldata
```

Complete the CorralData login in the browser window that opens, then confirm with `codex mcp list`.
{% endstep %}
{% endstepper %}

***

## After you connect

### Your first conversation

Try asking:

> "What databases and schemas are available in my CorralData account?"

Your assistant will use the `list_schemas` tool to discover your data. From there you can explore further:

> "Show me the tables in the public schema"

> "Describe the customers table — what columns does it have?"

> "Write a SQL query to find the top 10 customers by revenue this month"

### Understanding permissions

What you can do depends on your role in CorralData:

| Permission level            | What you can do                                                                                                         |
| --------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| **All authenticated users** | Explore schemas, tables, and relationships. Execute read-only SQL queries. View boards, widgets, filters, and datasets. |
| **board.edit role**         | All of the above, plus create and update boards and board filters.                                                      |
| **widget.edit role**        | All of the above, plus create and update widgets and datasets.                                                          |

If you try an action you don't have permission for, your assistant will let you know. Contact your CorralData administrator to request additional roles.

### Tips for effective use

* **Start with schema exploration** — Ask your assistant to list schemas and describe tables before writing queries. This helps it understand your data model and write accurate SQL.
* **Use progressive disclosure** — Ask for a list of boards first, then drill into a specific one. This keeps responses concise.
* **Be specific with SQL** — When asking for data, mention the table names and columns you're interested in.
* **Leverage filters** — When listing boards or widgets, mention the name or keyword you're looking for to narrow results.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.corraldata.com/kb/mcp/getting-started.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.