Skip to main content

Setup and installation

The MCP server is fully remote and does not require any local installation.

Staying on MCP server v1

The MCP server uses v2 by default, so the configuration examples below don't set a version header. To stay on the deprecated v1, send the mcp-version: v1 header instead. v1 will be removed, so plan to migrate to v2.

Using Olly through MCP

The configuration examples below include the x-allow-costly-use: true header, which turns on Olly tools. Olly tools are on by default, the same as when you set up the MCP server from the Coralogix UI. To turn them off, see Olly tools below. For the full Olly tool reference, see Olly.

Connecting with Cursor​

  1. Add the following to your .cursor/mcp.json file:

    {
    "mcpServers": {
    "coralogix-server": {
    "url": "https://api.eu2.coralogix.com/mgmt/api/v1/mcp",
    "headers": {
    "x-allow-costly-use": "true"
    }
    }
    }
    }
  2. Open the MCP settings in Cursor and enable the new MCP server.

  3. A browser window will open, log in to Coralogix and click Authorize to complete the connection.

Cursor handles authentication via OAuth 2.1 with OpenID Connect (OIDC). For more details, see Authorize MCP with OAuth 2.1.

API key​

  1. Add the following to your .cursor/mcp.json file:

    {
    "mcpServers": {
    "coralogix-server": {
    "url": "https://api.eu2.coralogix.com/mgmt/api/v1/mcp",
    "headers": {
    "Authorization": "Bearer <YOUR-API-KEY>",
    "x-allow-costly-use": "true"
    }
    }
    }
    }

    Replace <YOUR-API-KEY> with a Team or Personal Coralogix API key. See Choosing an API key.

  2. Open the MCP settings in Cursor and enable the new MCP server.

Note

If necessary, modify the https://api./mgmt/api/v1/mcp endpoint to correspond to your Coralogix domain using the domain selector at the top of the page.

Connecting with Claude Code​

Configure the MCP server using the Claude Code CLI.

  1. Register the MCP server:

    claude mcp add --transport http coralogix-server https://api.eu2.coralogix.com/mgmt/api/v1/mcp \
    --header "x-allow-costly-use: true"
  2. Authenticate:

    claude /mcp
    • Select coralogix-server.
    • Select Authenticate.
    • A browser window will open, log in to Coralogix and click Authorize to complete the connection.

Claude Code handles authentication via OAuth 2.1 with OpenID Connect (OIDC). For more details, see Authorize MCP with OAuth 2.1.

API key​

claude mcp add coralogix-server \
--transport http \
https://api.eu2.coralogix.com/mgmt/api/v1/mcp \
--header "Authorization: Bearer <YOUR-API-KEY>" \
--header "x-allow-costly-use: true"

Replace <YOUR-API-KEY> with a Team or Personal Coralogix API key. See Choosing an API key.

Note

If necessary, modify the https://api./mgmt/api/v1/mcp endpoint to correspond to your Coralogix domain using the domain selector at the top of the page.

Connecting with Codex​

Configure the MCP server in ~/.codex/config.toml and authenticate using the Codex CLI.

  1. Add the following to your ~/.codex/config.toml file:

    [mcp_servers.coralogix-server]
    url = "https://api.eu2.coralogix.com/mgmt/api/v1/mcp"
    http_headers = { "x-allow-costly-use" = "true" }
  2. Authenticate:

    codex mcp login coralogix-server

    A browser window will open, log in to Coralogix and click Authorize to complete the connection.

Codex handles authentication via OAuth 2.1 with OpenID Connect (OIDC). For more details, see Authorize MCP with OAuth 2.1.

API key​

  1. Set your API key as an environment variable:

    export CORALOGIX_API_KEY="<YOUR-API-KEY>"

    Replace <YOUR-API-KEY> with a Team or Personal Coralogix API key. See Choosing an API key.

  2. Add the following to your ~/.codex/config.toml file:

    [mcp_servers.coralogix-server]
    url = "https://api.eu2.coralogix.com/mgmt/api/v1/mcp"
    bearer_token_env_var = "CORALOGIX_API_KEY"
    http_headers = { "x-allow-costly-use" = "true" }
  3. Verify the configuration:

    codex mcp list
    codex mcp get coralogix-server
Note

If necessary, modify the https://api./mgmt/api/v1/mcp endpoint to correspond to your Coralogix domain using the domain selector at the top of the page.

Connecting with GitHub Copilot in VS Code​

  1. Add the following to your .vscode/mcp.json file:

    {
    "servers": {
    "coralogix-server": {
    "type": "http",
    "url": "https://api.eu2.coralogix.com/mgmt/api/v1/mcp",
    "headers": {
    "x-allow-costly-use": "true"
    }
    }
    }
    }
  2. In VS Code 1.101 or later, click Auth above coralogix-server in .vscode/mcp.json.

  3. A browser window will open, log in to Coralogix and click Authorize to complete the connection.

API key​

Add an Authorization header to the same entry:

{
"servers": {
"coralogix-server": {
"type": "http",
"url": "https://api.eu2.coralogix.com/mgmt/api/v1/mcp",
"headers": {
"Authorization": "Bearer <YOUR-API-KEY>",
"x-allow-costly-use": "true"
}
}
}
}

Replace <YOUR-API-KEY> with a Team or Personal Coralogix API key. See Choosing an API key.

Note

If necessary, modify the https://api./mgmt/api/v1/mcp endpoint to correspond to your Coralogix domain using the domain selector at the top of the page.

Connecting with other MCP clients​

The MCP server uses the Streamable HTTP transport and supports OAuth 2.1. Most clients accept a JSON entry in this shape:

{
"mcpServers": {
"coralogix": {
"url": "https://api.eu2.coralogix.com/mgmt/api/v1/mcp",
"headers": {
"x-allow-costly-use": "true"
}
}
}
}

If your client doesn't support OAuth, add "Authorization": "Bearer <YOUR-API-KEY>" to headers. See Choosing an API key.

Note

If necessary, modify the https://api./mgmt/api/v1/mcp endpoint to correspond to your Coralogix domain using the domain selector at the top of the page.

Choosing an API key​

OAuth is the recommended sign-in for a person working in their own coding agent. Use an API key when your client doesn't support OAuth, or when no one is there to sign in. The MCP server is another way to call the Coralogix APIs, so it accepts the same keys:

KeyUse it forPermissions
Personal keyOne person using an MCP client that doesn't support OAuthThe MCP server inherits the permissions of the user who owns the key.
Team keyAutomations, such as CI pipelines, scheduled jobs, and shared or headless agentsThe MCP server uses the permissions attached to the key. Team keys aren't tied to a user, so they keep working when people leave the team.

For details on both key types, see API keys. For the permissions each tool needs, see Permissions.

Olly tools​

Olly tools let your agent run longer investigations with Olly. The MCP server advertises them only when your client sends the x-allow-costly-use: true header, which every configuration example on this page includes. Olly tools draw AI units the same way Olly does in the Coralogix UI, counting toward both your team and personal limits.

To turn off Olly tools, remove the x-allow-costly-use header from your coralogix-server entry. The other MCP tools keep working.

Choosing toolsets​

The MCP server groups its tools into toolsets, with a toolset for each Coralogix product area. By default, your client gets every tool and skill. To load only the ones you need, add the mcp-toolsets header to your MCP server configuration with a comma-separated list of toolsets.

When you set the header:

  • Tools in the selected toolsets are available.
  • The core toolset is always on, whether or not you list it.
  • The server hides skills outside the selected toolsets.
  • Legacy v1 tools that don't belong to a toolset stay available.
  • A tool can belong to more than one toolset. For example, PromQL queries are available in metrics, data-usage, service-catalog, and slo.
  • Toolset names are case-insensitive, and the server ignores names it doesn't recognize. If the header has no recognized toolset names, your client gets every tool and skill.

For Cursor, add the header to your .cursor/mcp.json file:

{
"mcpServers": {
"coralogix-server": {
"url": "https://api.eu2.coralogix.com/mgmt/api/v1/mcp",
"headers": {
"mcp-toolsets": "alerts,metrics,spans"
}
}
}
}

For Claude Code, register the server with the header:

claude mcp add --transport http coralogix-server https://api.eu2.coralogix.com/mgmt/api/v1/mcp \
--header "mcp-toolsets: alerts,metrics,spans"

For Codex, add the header to the coralogix-server entry in ~/.codex/config.toml:

[mcp_servers.coralogix-server]
http_headers = { "mcp-toolsets" = "alerts,metrics,spans" }

If you authenticate with an API key in Cursor or Claude Code, keep the Authorization header alongside mcp-toolsets. Codex sends the key through --bearer-token-env-var, so it doesn't need an Authorization header.

Olly tools also need the x-allow-costly-use: true header (see Enabling Olly tools). To use the olly toolset, put both headers in the same entry. Don't add a second headers object or http_headers line: Cursor keeps only the last, and Codex can't load a config with a duplicate key.

For Cursor:

{
"mcpServers": {
"coralogix-server": {
"url": "https://api.eu2.coralogix.com/mgmt/api/v1/mcp",
"headers": {
"mcp-toolsets": "olly,alerts",
"x-allow-costly-use": "true"
}
}
}
}

For Claude Code, repeat the --header flag:

claude mcp add --transport http coralogix-server https://api.eu2.coralogix.com/mgmt/api/v1/mcp \
--header "mcp-toolsets: olly,alerts" \
--header "x-allow-costly-use: true"

For Codex:

[mcp_servers.coralogix-server]
http_headers = { "mcp-toolsets" = "olly,alerts", "x-allow-costly-use" = "true" }
ToolsetUse it to
coreAlways on. Query your data with DataPrime, including log queries, discover datasets and fields, and search the Coralogix documentation.
ai-centerInvestigate and manage AI applications, evaluations, and model pricing.
alertsInspect and manage alert definitions and cases.
billingManage quota allocation and cost-optimization policies for logs, traces, and RUM.
dashboardsFind and manage dashboards and folders.
data-usageInspect your data usage and correlate it with metrics.
infrastructureDiscover infrastructure resources and their details.
integrationsConfigure integrations and Fleet Management configurations.
logsConfigure parsing rules and data enrichment for incoming logs. To query logs, use core.
metricsDiscover metrics and labels, and run PromQL queries.
notificationsConfigure Notification Center routing.
ollyAsk Olly and retrieve its chats and artifacts. Also requires x-allow-costly-use: true.
profilingInvestigate Continuous Profiling data.
rbacManage custom roles.
rumLook up RUM SDK documentation.
service-catalogInspect service catalog entities, their relationships, and their metrics.
sloInspect service level objectives, their SLI queries, and linked alerts.
spansInvestigate service map relationships between your services.
viewsRetrieve and manage saved views and view folders.

For the tools themselves, see the Tools catalog.

Using a proxy for outbound connections​

If your network requires a proxy for outbound connections, set the standard HTTP_PROXY / HTTPS_PROXY environment variables before running your CLI client. The MCP client picks up your system proxy settings automatically.

export HTTPS_PROXY="https://your-proxy:port"

Starting a session​

Start a conversation by entering a prompt such as:

Show me the most frequent errors for service XYZ in the past week.

The assistant locates relevant log entries and identifies problematic functions. In AI tools that support MCP Apps, the answer can include a Coralogix view of the results. See MCP Apps.

Requesting a fix for agent-based IDEs​

After identifying the issue, for agent-based IDEs such as Cursor, instruct the assistant to fix it by saying:

Now, fix the issue.

You can also ask:

When did the issue start?

Additional resources​

Coralogix EndpointsCoralogix Endpoints

Next steps​

Configure and enable your MCP server to connect to Coralogix using OAuth.

Last updated on
On this page
Was this page helpful?