Skip to main content

​
Getting Started with Claude Code

Connect your Collate instance to Claude Code, Anthropic’s CLI-based AI coding assistant, for AI-powered metadata exploration directly from your terminal.

​
Prerequisites

Before you begin, ensure you have:
  1. Collate v1.8.0+ running.
  2. MCP Application installed in Collate.
    • Navigate to <YOUR-Collate-SERVER>/marketplace/apps/McpApplication.
    • Install McpApplication if it isn’t already installed.
  3. Claude Code installed (installation guide).
OAuth lets you authenticate using your existing Collate login, with no tokens to manage.

​
Step 1: Add the MCP Server

Open your terminal and run:
Replace <YOUR-Collate-SERVER> with your Collate instance URL, for example your-collate-instance.com. This registers the Collate MCP Server as an HTTP remote server in Claude Code.

​
Step 2: Authenticate

Start Claude Code and run the /mcp command:
You will see your collate server listed. Select Authenticate next to it. A browser window will open prompting you to sign in with your Collate credentials:
  • SSO (Google, Azure, Okta, and more): You will be redirected to your SSO provider’s login page.
  • Basic Auth: Enter your Collate username and password.
Once authenticated, Claude Code connects to your Collate MCP Server automatically.
Note: Authentication tokens are stored securely by Claude Code and refreshed automatically. Use the /mcp command and select Clear authentication to revoke access if needed.

​
Server Scope Options

By default, claude mcp add registers the server for the current project only (local scope). Change the scope as needed:

​
Connect with Personal Access Token (PAT)

If you prefer token-based authentication or OAuth is not available in your environment, use a Personal Access Token instead.

​
Step 1: Generate a PAT

To generate an access token, see Personal Access Token.

​
Step 2: Add the MCP Server with Authentication Header

Replace <YOUR-Collate-SERVER> with your Collate instance URL and <YOUR-Collate-PAT> with your Personal Access Token.

​
Alternative: JSON Configuration

Add the server using a JSON configuration instead:

​
Managing Your MCP Server

Claude Code provides several commands to manage your MCP servers:
Within a Claude Code session, use the /mcp command to view server status, authenticate, or clear authentication.

​
Try It Out

Once connected, start a Claude Code session and ask questions about your metadata:
Then try prompts like:
“What tables do you have access to in Collate?”
“Imagine you’re a data analyst tasked with building a customer retention dashboard. Find relevant customer and transaction tables in the metadata catalog.”
“Show me the lineage of data feeding the sales dashboard.”
You should see Claude Code using the Collate MCP tools to search and retrieve information from your metadata catalog.

​
Troubleshooting

If you encounter connection issues:
  1. Verify Collate is running: curl <YOUR-Collate-SERVER>/api/health.
  2. Check MCP endpoint: curl <YOUR-Collate-SERVER>/mcp (should return 401).
  3. Verify MCP Application is installed: Visit <YOUR-Collate-SERVER>/marketplace/apps/McpApplication.
  4. Check server status: Run /mcp in Claude Code to see if the server is connected.
  5. Re-authenticate: Run /mcp and select Clear authentication, then authenticate again.
  6. Verify configuration: Run claude mcp get collate to check the server configuration.
  7. Check Claude Code version: Ensure you’re running an up-to-date version with claude update.

​
Additional Resources