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

# Connect an AI Client

> Add the GermainUX MCP Server to Claude, ChatGPT, Claude Code, Cursor, VS Code and other MCP clients.

Availability
2026.3 or later

Your administrator must [enable the MCP Server](https://docs.germainux.com/integrations/mcp-server/enable-the-mcp-server.md) first.

## Before you start

You need:

* **The endpoint URL**, for example `https://example.cloud.germainux.com/mcp`. Ask your GermainUX administrator if you don't have it.
* **A way to sign in.** This is one of:
  * **OAuth (recommended):** you sign in with your normal GermainUX login when the client asks. There's nothing to copy.
  * **API key:** a key from your administrator, sent as an `Authorization: Bearer <key>` header.

> [!NOTE]
>
> Whichever you use, the AI client sees exactly the data your GermainUX user can see.

### What signing in looks like

The first time you connect with OAuth, your AI client opens a browser window:

**1. Log in to GermainUX**

If you aren't already logged in, you see the GermainUX login page. Log in as usual. SSO works.

**2. Approve the client**

GermainUX asks you to approve the AI client. Check that the client name is the one you expect, then approve it.

![GermainUX consent page asking to approve an AI client](https://mintcdn.com/germain-ux/CECS6ywIQd1P2KNL/images/image-228.png?fit=max\&auto=format\&n=CECS6ywIQd1P2KNL\&q=85\&s=381c80538751b9535ffe9375020586c7)

GermainUX asking you to approve an AI client

**3. Return to your AI client**

The browser returns you to your AI client, which is now connected.

You won't be asked again unless you stop using the client for a while (7 days by default) or your approval expires (after 90 days without use, by default).

## Add GermainUX to your client

> [tab] Claude
>
> For claude.ai and Claude Desktop:
>
> **1. Add a custom connector**
>
> Open **Settings → Connectors** and choose **Add custom connector**. Enter a name, such as `GermainUX`, and the endpoint URL.
>
> ![Adding GermainUX as a custom connector in Claude](https://mintcdn.com/germain-ux/CECS6ywIQd1P2KNL/images/image-229.png?fit=max\&auto=format\&n=CECS6ywIQd1P2KNL\&q=85\&s=e6cbe25f10486de10ca2f7a1fef30cf9)
>
> **2. Connect**
>
> Choose **Connect** and complete the GermainUX sign-in.
>
> **3. Check the tools**
>
> In a new chat, check that the GermainUX tools are listed in the tools menu.
>
> ![GermainUX tools listed in Claude](https://mintcdn.com/germain-ux/CECS6ywIQd1P2KNL/images/image-230.png?fit=max\&auto=format\&n=CECS6ywIQd1P2KNL\&q=85\&s=58507fe515955c9579409443b09816ee)
>
> > [!NOTE]
> >
> > On Team and Enterprise plans, an organization owner may need to add the connector first.

> [tab] Claude Code
>
> With OAuth:
>
> ```bash theme={null}
> claude mcp add --transport http germainux https://example.cloud.germainux.com/mcp
> ```
>
> Then run `/mcp` in Claude Code, select **germainux** and choose **Authenticate**.
>
> With an API key:
>
> ```bash theme={null}
> claude mcp add --transport http germainux https://example.cloud.germainux.com/mcp \
>   --header "Authorization: Bearer <your-api-key>"
> ```
>
> Add `--scope project` to share the server with your team through the project's `.mcp.json`. Don't commit API keys.
>
> ![Claude Code /mcp showing germainux as connected](https://mintcdn.com/germain-ux/CECS6ywIQd1P2KNL/images/image-231.png?fit=max\&auto=format\&n=CECS6ywIQd1P2KNL\&q=85\&s=f921f8c64bd765931b56bd70ab765f9a)

> [tab] Cursor
>
> Add the server to `~/.cursor/mcp.json` (for all projects) or `.cursor/mcp.json` (for one project):
>
> ```json theme={null}
> {
>   "mcpServers": {
>     "germainux": {
>       "url": "https://example.cloud.germainux.com/mcp"
>     }
>   }
> }
> ```
>
> Cursor shows a **Needs login** prompt for the server. Click it to sign in to GermainUX.
>
> To use an API key instead, add a header:
>
> ```json theme={null}
> "headers": { "Authorization": "Bearer <your-api-key>" }
> ```

> [tab] VS Code
>
> For GitHub Copilot in VS Code, add the server to `.vscode/mcp.json` in your workspace, or run **MCP: Add Server** from the Command Palette:
>
> ```json theme={null}
> {
>   "servers": {
>     "germainux": {
>       "type": "http",
>       "url": "https://example.cloud.germainux.com/mcp"
>     }
>   }
> }
> ```
>
> Start the server from the `mcp.json` editor or the Extensions view. VS Code prompts you to sign in. Use Copilot chat in **Agent** mode to use the tools.
>
> To use an API key without storing it in the file, prompt for it instead:
>
> ```json theme={null}
> {
>   "inputs": [
>     { "type": "promptString", "id": "germainuxKey", "description": "GermainUX API key", "password": true }
>   ],
>   "servers": {
>     "germainux": {
>       "type": "http",
>       "url": "https://example.cloud.germainux.com/mcp",
>       "headers": { "Authorization": "Bearer ${input:germainuxKey}" }
>     }
>   }
> }
> ```

> [tab] ChatGPT
>
> **1. Create a connector**
>
> Create a connector using the endpoint URL, with OAuth authentication.
>
> ![Creating a GermainUX connector in ChatGPT](https://mintcdn.com/germain-ux/CECS6ywIQd1P2KNL/images/image-232.png?fit=max\&auto=format\&n=CECS6ywIQd1P2KNL\&q=85\&s=c59121415639316838a4a0204fad2a95)
>
> **2. Sign in**
>
> Complete the GermainUX sign-in.
>
> **3. Use it in a chat**
>
> Enable the connector in a chat.

> [tab] Other clients
>
> Any MCP client that supports the **Streamable HTTP** transport can connect. Give it the endpoint URL. It then needs either:
>
> * OAuth support (it discovers GermainUX's sign-in automatically from the endpoint), or
> * a custom `Authorization` header with an API key:
>
> ```json theme={null}
> {
>   "mcpServers": {
>     "germainux": {
>       "url": "https://example.cloud.germainux.com/mcp",
>       "headers": {
>         "Authorization": "Bearer <your-api-key>"
>       }
>     }
>   }
> }
> ```
>
> Clients that only support local (stdio) servers can't connect directly.

## Check that it works

Ask something simple:

> What GermainUX KPIs are available, and what's the current time in our environment?

The client should call `how_to_use_germainux_tools`, `list_kpis` and `get_current_time`, and answer with your KPIs.

## Troubleshooting

| Symptom | Likely cause |
| - | - |
| 404 Not Found on the endpoint | The MCP Server isn't enabled, or OAuth is misconfigured. Ask your administrator to check the service log. |
| 401 Unauthorized | The API key is invalid, expired or disabled, or your OAuth session expired. Reconnect. |
| Sign-in fails with "redirect\_uri is not allowed" | Your administrator hasn't allowed this AI client. Claude, ChatGPT and clients running on your machine are allowed by default. Other hosted clients must be added. |
| Connected, but some data is missing | You only see data your GermainUX user is allowed to see. |
| `search_content` isn't available | Content search requires a content indexer. |
| "Query rate limit reached" or "server is busy" | You hit a usage limit. Wait a few seconds, or ask for less in one question. |

## Next steps

> [card] [Example Prompts](https://docs.germainux.com/integrations/mcp-server/example-prompts.md)
>
> See what you can ask, and how the tools answer.

## Get Help

> [card] [Contact GermainUX Support](https://docs.germainux.com/getting-started/support.md)
>
> The GermainUX team helps you get up and running faster, empower your team, turn data into actionable insights, and optimize performance to deliver measurable business outcomes.

> [card] Can't Find What You Need?
>
> Search all GermainUX docs with **Ctrl + K**, or use the feedback buttons at the bottom of this page to tell us what is missing.

The content of this document is proprietary to GERMAIN SOFTWARE.


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