Connect Claude Code to Telivy

This page shows how to add the Telivy MCP server to Claude Code, Anthropic’s command-line coding assistant. Claude Code connects to remote MCP servers over HTTP and can send the x-api-key header that Telivy requires, so no bridge is needed.

Prerequisites

Claude Code installed and signed in.
Your agency’s Telivy API key from Account → Integrations. See Authentication and permissions for what the key can do.

Store the key in an environment variable

Both setup options below read the key from an environment variable named TELIVY_API_KEY, so the key never has to be typed into a command or a shared file.

macOS and Linux
Windows

Add this line to your shell profile (for example ~/.zshrc or ~/.bashrc), then open a new terminal:

export TELIVY_API_KEY="your-telivy-api-key"

Run this in PowerShell, then open a new terminal:

setx TELIVY_API_KEY "your-telivy-api-key"

Add the server

Choose one option. The first makes Telivy available to you in every project. The second adds Telivy to a single repository so everyone who works in it gets the same configuration, with each person supplying their own environment variable.

For you, in every project
For one project, shared with your team

On macOS or Linux, run:

claude mcp add --transport http --scope user telivy https://api-v1.telivy.com/mcp \
  --header "x-api-key: $TELIVY_API_KEY"

On Windows, run this in PowerShell:

claude mcp add --transport http --scope user telivy https://api-v1.telivy.com/mcp --header "x-api-key: $env:TELIVY_API_KEY"

PowerShell reads environment variables as $env:TELIVY_API_KEY. Written as $TELIVY_API_KEY, it refers to an unset PowerShell variable, and Claude Code would save an empty key. Run the command in a PowerShell window opened after setx, because setx does not change the window it runs in.Your shell replaces the variable with the key before the command runs, so Claude Code saves the key value itself in ~/.claude.json in your home folder. That file is private to your user account and is not part of any repository. If you regenerate the key, remove the server and add it again.

Create or edit .mcp.json in the root of the project:

{
  "mcpServers": {
    "telivy": {
      "type": "http",
      "url": "https://api-v1.telivy.com/mcp",
      "headers": {
        "x-api-key": "${TELIVY_API_KEY}"
      }
    }
  }
}

Claude Code expands ${TELIVY_API_KEY} from the environment when it loads the file, so the file contains only the variable name and can be committed. Each person who uses the project sets TELIVY_API_KEY in their own environment.

Verify the connection

Run claude mcp list in a terminal. The telivy server should show as connected. A Failed to connect status usually means the key is missing or wrong; see Troubleshooting.
Start Claude Code and type /mcp. Select telivy to see its status and the list of Telivy tools.

Approvals

Claude Code asks for permission before it runs an MCP tool. Keep that behavior for any Telivy tool that creates, updates, rescans or uninstalls something. If you add permission rules to allow tools without a prompt, list only read-only tools by their full name, which has the form mcp__telivy__<tool name>, for example mcp__telivy__get_risk_assessments, and appears when you select a tool in /mcp. Do not allow mcp__telivy__* as a whole.

Try it

Start Claude Code and send a prompt such as:

Using the Telivy tools, list my five most recent external scans and tell me which ones have critical findings.

Claude Code asks for permission to call the Telivy tools it needs, then answers from the data they return. For more prompts, see Example workflows.

Remove the server

If you added Telivy for yourself in every project, run:

claude mcp remove telivy --scope user

If you added it to a project, delete the telivy entry from that project’s .mcp.json. To stop using the key on this computer, also remove the TELIVY_API_KEY line from your shell profile, or run this in PowerShell on Windows:

[Environment]::SetEnvironmentVariable("TELIVY_API_KEY", $null, "User")

Getting Started

Learning Center

Products

Frequently Asked Questions

Scoring

Integrations

Additional Information

Connect Claude Code to Telivy

Prerequisites

Store the key in an environment variable

Add the server

Verify the connection

Approvals

Try it

Remove the server

​Prerequisites

​Store the key in an environment variable

​Add the server

​Verify the connection

​Approvals

​Try it

​Remove the server

Prerequisites

Store the key in an environment variable

Add the server

Verify the connection

Approvals

Try it

Remove the server