MCP API Key User Guide

This guide explains how to generate and use API keys to connect AI assistants to your HelpDesk system.

What is MCP?

The Model Context Protocol (MCP) is an open standard that allows AI assistants like Claude, Gemini, and ChatGPT to interact with external tools and services. With an MCP API key, you can enable your AI assistant to:

• Create support tickets using natural language
• List and search existing tickets
• Add replies to tickets
• Create and manage tasks
• Query ticket status and details

Getting Your API Key

Step 1: Access the Portal

Visit the MCP API Key Portal at:

https://your-helpdesk-url/mcp

Step 2: Sign In

Click “Sign in with Google” and authenticate with your Google account. You must use an account that has access to the HelpDesk system.

Step 3: Create a New Key

1. Click the “Create New Key” button
2. Enter a name for your key (e.g., “Claude Desktop”, “My ChatGPT Key”)
3. Select the tenant you want the key to access
4. Click “Create Key”

Step 4: Copy Your Key

Important: Your API key will only be shown once! Copy it immediately and store it securely.

The key format looks like: hdsk_aBcDeFgHiJkLmNoPqRsTuVwXyZ123456

Configuring Your AI Assistant

Claude Code / Claude Desktop

Add the following to your MCP configuration:

Claude Code (.mcp.json in your project):

{
  "mcpServers": {
    "helpdesk": {
      "type": "sse",
      "url": "https://mcp-a5kjn6gt4q-uc.a.run.app/sse",
      "headers": {
        "X-API-Key": "hdsk_your_key_here"
      }
    }
  }
}

Claude Desktop (claude_desktop_config.json):

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "helpdesk": {
      "command": "npx",
      "args": ["mcp-remote-client", "https://mcp-a5kjn6gt4q-uc.a.run.app"],
      "env": {
        "MCP_API_KEY": "hdsk_your_key_here"
      }
    }
  }
}

Other AI Assistants

For AI assistants that support MCP, use these connection details:

Setting	Value
Endpoint URL	https://mcp-a5kjn6gt4q-uc.a.run.app/sse
Transport	SSE (Server-Sent Events)
Authentication	Header: X-API-Key: hdsk_your_key_here

Using Your AI Assistant with HelpDesk

Once configured, you can ask your AI assistant to:

Create Tickets

“Create a support ticket about the printer on the 3rd floor not working. Mark it as high priority.”

List Tickets

“Show me all open tickets” “List the 5 most recent tickets”

Search Tickets

“Find tickets about network issues” “Search for tickets mentioning ‘password reset‘“

Get Ticket Details

“Get details for ticket ABC123” “What’s the status of my printer ticket?”

Add Replies

“Add a note to ticket XYZ789 saying the issue has been resolved”

Create Tasks

“Create a task to order new printer cartridges, due next week”

Managing Your Keys

Viewing Your Keys

The portal shows all your API keys with:

• Key prefix: First few characters for identification
• Status: Active or Revoked
• Created date: When the key was generated
• Last used: When the key was last used
• Usage count: Total number of API calls made

Deleting a Key

If a key is compromised or no longer needed:

1. Go to the MCP API Key Portal
2. Find the key in your list
3. Click the delete icon
4. Confirm deletion

Warning: Deleting a key is permanent. Any AI assistants using that key will immediately lose access.

Security Best Practices

1. Never share your API key publicly or in code repositories
2. Create separate keys for different applications or devices
3. Delete unused keys to minimize security risk
4. Monitor usage via the portal to detect unauthorized access
5. Rotate keys periodically by creating new keys and deleting old ones

Troubleshooting

”Invalid API key” Error

• Verify you copied the complete key (starts with hdsk_)
• Check that the key hasn’t been deleted
• Ensure the key is in the correct configuration file

AI Assistant Can’t Connect

• Verify the endpoint URL is correct
• Check that your key is active (not revoked)
• Restart your AI assistant after configuration changes

”Access denied” Errors

• Your key may not have access to the requested tenant
• Contact your administrator if you need access to additional tenants

Key Not Working After Copy

• Make sure you copied the full key without extra spaces
• The key should be exactly as shown (37 characters including prefix)

FAQ

Q: How many keys can I create? A: You can create multiple keys. We recommend creating separate keys for each application or device.

Q: Do keys expire? A: No, keys do not automatically expire. You can delete them manually when no longer needed.

Q: Can I see my full API key after creation? A: No, for security reasons the full key is only shown once at creation. If you lose it, create a new key.

Q: What happens if my key is compromised? A: Delete the compromised key immediately via the portal and create a new one.

Q: Can I use the same key in multiple AI assistants? A: Yes, but we recommend separate keys for better security and usage tracking.

Support

If you encounter issues not covered in this guide, please create a support ticket through your HelpDesk system or contact your administrator.