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

# Connect your AI assistant to Upwell

> Install Upwell from the Claude directory or configure a remote MCP connection to look up freight billing records in your workspace.

Use your assistant to look up an invoice, check a payment, or find a shipment's proof of delivery. The Upwell connector gives it read-only access to records your Upwell account can see.

You'll need an active Upwell Admin, Manager, Team Member, Cash Application, or system administrator account in a workspace with MCP access enabled. If Upwell says your organization doesn't have access, contact [Upwell support](mailto:support@upwell.com).

## Claude

1. Open [Upwell in the Claude directory](https://claude.ai/directory/upwell). You can also search for **Upwell** in Claude's connector directory.
2. Select **Connect**. If your organization manages connectors and Upwell is unavailable, ask a workspace administrator to enable the directory connector, then return to the listing.
3. Sign in to Upwell. Check that the consent screen shows the expected app, account, and workspace, then select **Allow Access**.
4. Open a Claude chat, enable Upwell in the connectors menu, and try the invoice lookup below.

## Manual setup

Use this server URL wherever your assistant asks for an MCP endpoint. It connects to your workspace over **Streamable HTTP**.

```text theme={null}
https://app.upwell.com/api/mcp
```

> [tab] ChatGPT
>
> 1. Open [Plugins in ChatGPT](https://chatgpt.com/plugins) on the web. Select **+ → Add custom MCP server**. On Business, an owner or administrator creates the connection. On Enterprise or Edu, ask a workspace administrator for access if the option is unavailable.
> 2. Enter `Upwell` as the name and `Look up freight billing records` as the description. Under **Connection**, choose the public HTTPS endpoint and paste the server URL above.
> 3. Choose **OAuth**. Leave optional client ID and client secret fields empty so ChatGPT can discover the sign-in settings. Review the warning, acknowledge it, and select **Create as a plugin**.
> 4. Sign in to Upwell when prompted, check the account and workspace, and select **Allow Access**. Review the discovered tools and install the plugin. Start a new chat and type `@Upwell` to select it.
>
> [ChatGPT setup guide](https://developers.openai.com/plugins/deploy/connect-chatgpt)

> [tab] Grok
>
> 1. Open [Grok Connectors](https://grok.com/connectors). For personal setup, select **New Connector → Custom** and paste the Upwell server URL above.
> 2. For Grok Business or Enterprise, a team administrator first selects the team in the xAI console, opens **Grok Business → Connectors → + Add Connector**, chooses **Other**, and enters the same server URL.
> 3. In a managed team, open the connector your administrator added on your own Grok Connectors page. Each member authorizes their own Upwell account.
> 4. Follow the sign-in prompt, confirm your Upwell account and workspace, and select **Allow Access**. Open a Grok conversation and try the lookup below.
>
> [Grok connector setup](https://docs.x.ai/grok/connectors) · [Team administrator steps](https://docs.x.ai/grok/connector-management)

> [tab] VS Code
>
> 1. Open the Command Palette and run **MCP: Add Server**.
> 2. Choose **HTTP**, paste the server URL above, and enter `upwell` as the server ID. Choose your personal or global configuration when prompted.
> 3. Open **MCP Servers** in chat customizations and start **upwell** if prompted. Review the trust prompt, sign in to Upwell, confirm the workspace, and select **Allow Access**.
> 4. In an agent chat, enable the Upwell tools in the tool picker and try the lookup below.
>
> [VS Code MCP setup](https://code.visualstudio.com/docs/agent-customization/mcp-servers)

> [tab] Gemini CLI
>
> 1. On a computer where you can complete browser sign-in, run the following in a terminal.
>
>    ```bash theme={null}
>    gemini mcp add --scope user --transport http upwell https://app.upwell.com/api/mcp
>    ```
>
> 2. Start Gemini CLI. At its prompt, enter `/mcp auth upwell` if it asks you to authenticate.
>
> 3. Sign in to Upwell, confirm the workspace, and select **Allow Access**. Back in Gemini CLI, enter `/mcp list` to see the connected server before running the lookup below.
>
> [Gemini CLI MCP setup](https://geminicli.com/docs/tools/mcp-server/)

> [tab] Cursor desktop
>
> These steps use an Upwell API key. You'll need access to **Account → API keys** in Upwell. The MCP tools are read-only, but the key can also authenticate to other Upwell API endpoints.
>
> 1. Create a dedicated key for Cursor using the [Upwell API key instructions](https://docs.upwell.com/authentication.md). Store it in the environment variable `UPWELL_API_KEY` and launch Cursor with that variable available to it.
>
> 2. Open your personal Cursor configuration at `~/.cursor/mcp.json`. For a new file, use the example below. If it already contains servers, add only the `upwell` entry inside `mcpServers`. Keep the environment reference in the file so the key stays out of the configuration.
>
>    ```json theme={null}
>    {
>      "mcpServers": {
>        "upwell": {
>          "url": "https://app.upwell.com/api/mcp",
>          "headers": {
>            "Authorization": "Bearer ${env:UPWELL_API_KEY}"
>          }
>        }
>      }
>    }
>    ```
>
> 3. Save the file. In Cursor's MCP settings, enable **upwell** and check that its tools appear. Open an Agent chat and try the lookup below.
>
> [Cursor MCP configuration](https://cursor.com/docs/mcp)

## Check the connection

Choose a customer invoice you can already open in Upwell. Replace the bracketed text with its number and ask your assistant the following question.

> Use Upwell to look up customer invoice \[invoice number]. What is its payment status? Include a link to the invoice.

Open the returned record and compare its invoice number and payment status with the answer. If the assistant returns documentation instead, check that the configured URL is `https://app.upwell.com/api/mcp`. The separate [documentation search server](https://docs.upwell.com/developer-guide/ai-tools.md#connect-the-documentation-search-server) answers questions about the public guides.

## Disconnect

For connections made through Upwell sign-in, open **Account → Connected apps**, find the assistant, and select **Revoke access**. Cash Application users can open **Connected apps** directly from the sidebar. For the Cursor API-key setup, revoke the dedicated key under **Account → API keys** and remove the server entry from Cursor.


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