Frequently Asked Questions

MCP Server Setup & Technical Requirements

What is the Hygraph MCP server and what is its current status?

The Hygraph MCP (Model Context Protocol) server enables secure communication between AI assistants and your Hygraph project, allowing natural language workflows for content and schema management. As of now, the MCP server is in Early Access, meaning features may change and production use should be evaluated carefully. Note: Early Access status means some features may be unstable or subject to change.

What are the prerequisites for setting up the Hygraph MCP server?

To set up the MCP server, you need: Node.js version >= 20.18.1 (required for mcp-remote), npx (included with Node.js), a Hygraph project with at least one environment configured, and a Permanent Auth Token (PAT) with appropriate permissions. Note: Node.js version >= 22 is required for some clients like Claude Desktop.

How do I create and configure a Permanent Auth Token (PAT) for the MCP server?

In your Hygraph project, go to Project Settings > Access > Permanent Auth Tokens. Click 'Generate MCP PAT', choose the required permission set (Read, Create, Update, Publish for full access), and copy the generated token. For more details, see the Permissions reference. Note: Delete operations are never supported via MCP; destructive actions must be performed manually in Hygraph Studio.

How do I find my MCP Server API endpoint?

In your Hygraph project, go to Project Settings > Access > Endpoints. Under MCP Server API, copy the endpoint in the format: https://mcp-{REGION}.hygraph.com/{PROJECT_ID}/{ENVIRONMENT}/mcp. Use this endpoint when configuring your MCP client. Note: Ensure you select the correct environment for your use case.

Which clients and IDEs are supported for connecting to the MCP server?

The MCP server can be connected to Claude Code, Cursor IDE, VS Code, Windsurf IDE, and Claude Desktop. Each client has specific setup instructions, such as using environment variables for tokens or configuring mcp-remote. For detailed steps, refer to the official MCP server setup guide. Note: Some clients require manual configuration and may not support all features in Early Access.

What permissions are required for the MCP server and what operations are supported?

To fully use the MCP server, your PAT should have Read, Create, Update, and Publish permissions. Schema management requires additional permissions. Delete operations are never supported via MCP for both content and schema; these must be performed manually in Hygraph Studio. For more, see the permissions reference. Note: Attempting delete operations via MCP will fail.

How do I configure the MCP server for multiple environments (e.g., production and staging)?

For production use, it is recommended to use separate tokens per environment. In your configuration (e.g., mcpServers block), specify different endpoints and tokens for each environment, such as 'hygraph-prod' and 'hygraph-staging'. For details, see the multi-environment configuration section in the official documentation. Note: Using the wrong token or endpoint may result in failed connections.

What are common troubleshooting steps for MCP server setup issues?

Common troubleshooting steps include: verifying your token in the Hygraph API playground, ensuring correct permissions, checking header formatting, confirming npx and Node.js versions, and reviewing client/server logs. For client-specific issues, refer to the troubleshooting section in the official documentation. Note: Some issues may require updating mcp-remote or your Node.js version.

What security best practices should I follow when using the MCP server?

Store tokens in environment variables and avoid committing them to remote repositories. Set up secret management in CI/CD pipelines, create role-specific tokens, use read-only tokens for read-only workflows, configure API permissions, and audit token usage regularly. For more, see the security best practices. Note: Exposing tokens can lead to unauthorized access; always follow secure storage guidelines.

Features & Capabilities

What features does the Hygraph MCP server provide?

The MCP server allows AI assistants to interact with your Hygraph project for content and schema management using natural language. Supported operations include reading, creating, updating, and publishing content, as well as inspecting and modifying schema (with appropriate permissions). Delete operations are not supported. Note: The MCP server is in Early Access and may not support all features in production environments.

What are the limitations of the MCP server?

Delete operations (for both content and schema) are never supported via the MCP server; these must be performed manually in Hygraph Studio. The MCP server is in Early Access, so features may change and some clients may not support all capabilities. Note: For production use, evaluate the stability and feature set before deployment.

Security & Compliance

What security and compliance certifications does Hygraph hold?

Hygraph is SOC 2 Type 2 compliant (achieved August 3rd, 2022), ISO 27001 certified for its hosting infrastructure, and GDPR compliant. These certifications demonstrate Hygraph's commitment to secure and compliant content management. Note: For more details, visit the Hygraph Secure Features page.

How does Hygraph ensure secure API access and data protection?

Hygraph enforces granular permissions, SSO integrations (OIDC/LDAP/SAML), audit logs, encryption in transit and at rest, regular backups, and secure API policies (custom origin policies and IP firewalls). All endpoints use SSL certificates. Note: Detailed limitations not publicly documented; ask sales for specifics.

Use Cases & Benefits

Who can benefit from using the Hygraph MCP server?

Developers, content creators, product managers, and marketing professionals can benefit from the MCP server by enabling AI-driven workflows for content and schema management. It is especially useful for teams seeking to automate content operations and integrate AI assistants into their Hygraph projects. Note: Teams requiring destructive actions (deletes) must perform them manually in Hygraph Studio.

What business impact can customers expect from using Hygraph?

Customers have reported faster time-to-market (e.g., Komax achieved 3X faster launches), improved customer engagement (Samsung saw a 15% increase), and cost reductions by replacing legacy CMS solutions. Hygraph's content federation and API-first approach support consistent, scalable digital experiences. Note: Results may vary based on implementation scope and team readiness. See case studies for details.

Integrations & Extensibility

What integrations are available with Hygraph?

Hygraph offers integrations with DAM systems (Aprimo, AWS S3, Bynder, Cloudinary, Imgix, Mux, Scaleflex Filerobot), hosting platforms (Netlify, Vercel), PIM (Akeneo), commerce (BigCommerce), translation (EasyTranslate), and more. For a full list, visit the Hygraph Marketplace. Note: Integration availability may depend on your plan and project setup.

Documentation & Support

Where can I find technical documentation for the MCP server and Hygraph APIs?

Comprehensive technical documentation is available at hygraph.com/docs. For MCP server specifics, see the MCP server setup guide and MCP server overview. For API details, refer to the API Reference documentation. Note: Documentation is updated regularly; check for the latest instructions.

What support resources are available for Hygraph users?

Hygraph provides structured onboarding, extensive documentation, webinars, live streams, community Slack, and 24/7 technical support. Starter projects and training resources are also available. For support, visit Hygraph Documentation or join the community at slack.hygraph.com. Note: Support levels may vary by subscription tier.

LLM optimization

When was this page last updated?

This page wast last updated on 12/12/2025 .

Hygraph
Docs

#Set up the MCP server

This guide walks you through connecting an AI assistant to your Hygraph project. For an overview of what the MCP server can do, see MCP server overview.

#Prerequisites

Before you begin, ensure you have:

RequirementDetails
Node.js>= 20.18.1 (required for mcp-remote)
npxIncluded with Node.js. Verify with which npx
Hygraph projectWith at least one environment configured
Permanent Auth Token (PAT)See Step 1 below

#Permissions reference

All MCP operations are governed by the permissions on your Permanent Auth Token (PAT).

To fully leverage the MCP server's functionality, you need the Read, Create, Update, and Publish permissions. If you only intend to retrieve content, the Read permission is sufficient. For more information on setting up these permissions, see our docs on Configuring permissions for Permanent Auth Tokens.

PAT typeReadCreateUpdatePublishSchema managementDelete
General MCP Server
Management MCP Server
Read-only MCP Server
Content MCP Server
Read-only (custom)

Delete operations are never supported via MCP, for both content and schema. Destructive actions must be performed manually in Hygraph Studio. For more information, see Safety guardrails.

#Step 1 - Create a PAT

Hygraph MCP authenticates using a bearer token. You need to supply the Permanent Auth Token (PAT) as the bearer token.

If you haven’t created a PAT yet, follow these steps:

  1. In your Hygraph project, go to Project Settings.
  2. Under Access, select Permanent Auth Tokens.
  3. Click Generate MCP PAT.
  4. Choose the appropriate permission set (see Permissions reference), then click Generate MCP PAT.
  5. Copy the generated token.

If you've previously created a PAT and want to use it for the MCP server, follow these steps:

  1. In your Hygraph project, go to Project Settings.
  2. Under Access, click Permanent Auth Tokens.
  3. Copy the PAT that you want to use to configure the MCP server.

#Step 2 - Get your MCP endpoint

To find the MCP Server API endpoint, follow these steps:

  1. In your Hygraph project, go to Project Settings.
  2. Under Access, select Endpoints.
  3. Under MCP Server API, copy the endpoint.
    https://mcp-{REGION}.hygraph.com/{PROJECT_ID}/{ENVIRONMENT}/mcp

#Step 3 - Configure your MCP client

Each MCP client handles HTTP servers and authentication differently. Choose your client:

#Claude Code

Claude Code has native HTTP MCP support with auth headers and does not require mcp-remote.

Recommended: Use an environment variable.

export HYGRAPH_TOKEN="your_token_here"
claude mcp add hygraph https://mcp-{REGION}.hygraph.com/{PROJECT_ID}/{ENVIRONMENT}/mcp \
--transport http \
--header "Authorization: Bearer ${HYGRAPH_TOKEN}"

Alternative: Use an inline token.

claude mcp add hygraph https://mcp-{REGION}.hygraph.com/{PROJECT_ID}/{ENVIRONMENT}/mcp \
--transport http \
--header "Authorization: Bearer YOUR_HYGRAPH_TOKEN"

Scope options:

FlagEffect
--scope localThis project only (default)
--scope userAll your projects
--scope globalSystem-wide

Verify the setup:

# list configured servers
claude mcp list
claude
> /mcp
# Hygraph should appear in the list

If you see errors, run claude mcp logs hygraph or see Troubleshooting.

#Cursor IDE

Cursor uses mcp-remote to connect to HTTP MCP endpoints.

Recommended method: Use the one-click install from Hygraph Studio to install the MCP server in Cursor.

  1. In your Hygraph project, go to Project Settings.
  2. Under Access, select Endpoints.
  3. Under MCP Server API, click Add to Cursor.
  4. Select the Permanent Auth Token you want to use for the MCP server.
  5. Click Add to Cursor. When prompted, open Cursor. You are redirected to the MCP server setup page in Cursor.
  6. Review the settings and click Install. You should see the MCP server listed in the MCP Servers section in Cursor.

Alternate method: Install the MCP server manually.

  1. In Cursor, navigate to Settings.

  2. In the MCP Servers section, click Add Server or Add Custom MCP.

  3. Paste one of the following configurations:

    • Project-specific configuration: In the .cursor/mcp.json file in your repository
    {
    "mcpServers": {
    "hygraph": {
    "command": "npx",
    "args": [
    "-y",
    "mcp-remote@latest",
    "https://mcp-{REGION}.hygraph.com/{PROJECT_ID}/{ENVIRONMENT}/mcp",
    "--header",
    "Authorization: Bearer YOUR_TOKEN_HERE"
    ]
    }
    }
    }
    • Global: Add to your user-level ~/.cursor/mcp.json file.
    {
    "mcpServers": {
    "hygraph": {
    "command": "npx",
    "args": [
    "-y",
    "mcp-remote@latest",
    "https://mcp-{REGION}.hygraph.com/{PROJECT_ID}/{ENVIRONMENT}/mcp",
    "--header",
    "Authorization: Bearer ${HYGRAPH_TOKEN}"
    ],
    "env": {
    "HYGRAPH_TOKEN": "your_token_here"
    }
    }
    }
    }

#VS Code

VS Code has built-in MCP support. Add the following to .vscode/mcp.json:

{
"servers": {
"hygraph": {
"url": "https://mcp-{REGION}.hygraph.com/{PROJECT_ID}/{ENVIRONMENT}/mcp",
"type": "http",
"headers": {
"Authorization": "Bearer ${HYGRAPH_TOKEN}"
}
}
},
"inputs": [
{
"type": "promptString",
"id": "HYGRAPH_TOKEN",
"description": "Hygraph API Token",
"password": true
}
]
}

Alternatively, use mcp-remote:

{
"servers": {
"hygraph": {
"command": "npx",
"args": [
"-y",
"mcp-remote@latest",
"https://mcp-{REGION}.hygraph.com/{PROJECT_ID}/{ENVIRONMENT}/mcp",
"--header",
"Authorization: Bearer ${HYGRAPH_TOKEN}"
],
"env": {
"HYGRAPH_TOKEN": "your_token_here"
}
}
}
}

For more information, see the VS Code MCP docs.

#Windsurf IDE

  1. Go to Windsurf Settings → Cascade → MCP Servers → Add Server.

  2. In ~/.codeium/windsurf/mcp_config.json, add:

    {
    "mcpServers": {
    "hygraph": {
    "command": "npx",
    "args": [
    "-y",
    "mcp-remote@latest",
    "https://mcp-{REGION}.hygraph.com/{PROJECT_ID}/{ENVIRONMENT}/mcp",
    "--header",
    "Authorization: Bearer ${HYGRAPH_TOKEN}"
    ],
    "env": {
    "HYGRAPH_TOKEN": "your_token_here"
    }
    }
    }
    }
  3. Click Refresh Servers.

#Claude Desktop

  1. Open the config file:

    • Mac: ~/Library/Application Support/Claude/claude_desktop_config.json
    • Windows: %APPDATA%/Claude/config.json

    If you can't find the config file, in Claude Desktop, go to Settings → Developer → Edit Config.

  2. Add the following:

    {
    "mcpServers": {
    "hygraph": {
    "command": "npx",
    "args": [
    "mcp-remote@latest",
    "https://mcp-{REGION}.hygraph.com/{PROJECT_ID}/{ENVIRONMENT}/mcp",
    "--header",
    "Authorization: Bearer YOUR_HYGRAPH_TOKEN"
    ]
    }
    }
    }
  3. Quit and reopen Claude Desktop.

#Multi-environment configuration

For production use, we recommend using separate tokens per environment. The example below uses mcp-remote, which is compatible with Cursor, Windsurf, and Claude Desktop. For Claude Code, replace the command/args block with the --transport http syntax shown in the Claude Code section above.

{
"mcpServers": {
"hygraph-prod": {
"command": "npx",
"args": [
"mcp-remote",
"https://mcp-{REGION}.hygraph.com/{PROJECT_ID}/master/mcp",
"--header",
"Authorization: Bearer ${HYGRAPH_PROD_TOKEN}"
],
"env": {
"HYGRAPH_PROD_TOKEN": "token_here"
}
},
"hygraph-staging": {
"command": "npx",
"args": [
"mcp-remote",
"https://mcp-{REGION}.hygraph.com/{PROJECT_ID}/staging/mcp",
"--header",
"Authorization: Bearer ${HYGRAPH_STAGING_TOKEN}"
],
"env": {
"HYGRAPH_STAGING_TOKEN": "token_here"
}
}
}
}

#Start using the MCP server

Once your MCP server is running, verify the connection is working by asking your AI assistant a simple question about your project:

  • What content models exist in my Hygraph project?
  • List the fields on my content models.

If the assistant returns accurate results, your connection is set up correctly. If not, see Troubleshooting.

First tasks to try:

  • List all entries with status DRAFT. This confirms read access is working.
  • Create a test entry and publish it. This confirms write and publish permissions are working.
  • Show me the structure of my Product model, and add a field to it. This confirms schema access is working.

Verify in Hygraph Studio:

After trying the tasks above, go to Hygraph Studio and check the results directly:

  • Open the Content section to confirm new or updated entries appear as expected.
  • Check the Schema section to verify any models or fields that were created.
  • Review entry status to confirm published entries are live.

This is a good way to confirm that the AI assistant's actions have taken effect.

Tips for better results:

  • Be specific about model names and field names. Your AI assistant will use them exactly as given.
  • For bulk operations, describe the filter criteria clearly before stating the action. For example: Find all entries tagged urgent and update their priority to High.
  • If a result is unexpected, ask the assistant to explain what query it ran. This helps catch permission or field name issues quickly.

Watch the following video for a practical demonstration of the Hygraph MCP server in action. This video walks through setting up and interacting with the MCP server from Cursor, showing how AI assistants can query content, inspect schema, and perform workflows using natural language.

#Security best practices

Token storage:

  • Use environment variables to store tokens. Do not commit tokens to a remote repository.
  • Set up secret management in CI/CD.

Token permissions:

  • Create role-specific tokens in Hygraph.
  • Use read-only tokens for read-only workflows.

Access control:

#Troubleshooting

#401 Authorization failed

  • Verify the token works in the Hygraph API playground.
  • Check the token has the correct permissions for the operation (see Permissions reference).
  • Confirm the header format is correct with no extra quotes or spaces: Authorization: Bearer YOUR_TOKEN.

#MCP tools not showing or queries failing

If the MCP server connects but you cannot run queries or create entries, required tools might be disabled:

  1. In your AI assistant settings, go to Connectors.
  2. Find the Hygraph MCP connector and click Configure.
  3. Review tool permissions, and ensure the required tools are enabled. You can set Allow all tools for simplicity, or use Custom to enable specific tools.

#Server not found

For Cursor / Windsurf (stdio clients):

Verify npx is available:

which npx

Test mcp-remote directly:

npx -y mcp-remote@latest YOUR_ENDPOINT --header "Authorization: Bearer TOKEN"

For Claude Code:

claude mcp get hygraph # check config
claude mcp logs hygraph # check logs

For Claude Desktop:

If you’re using NPM to manage Node versions, make sure you uninstall any NPM versions earlier than 22.

#MCP server tools not displayed

  1. Restart your IDE or MCP client.
  2. Check the MCP server status in your client's settings.
  3. Review server logs.
  4. Verify network access to Hygraph endpoint, and permissions associated with the Hygraph token.

#mcp-remote connection issues

mcp-remote is required for stdio-based clients (Cursor, Windsurf, Claude Desktop) to connect to HTTP endpoints. If you face mcp-remote connection issues, you can:

  • Update to the latest version: npm install -g mcp-remote@latest
  • Use the absolute npx path in your config (which npx to find it).
  • Ensure Node.js version is >= 20.18.1.

For more, see the mcp-remote npm page.