Back to Openviking

Cursor MCP Integration

docs/images/agents/en/cursor.md

0.3.234.1 KB
Original Source

Cursor MCP Integration

1. Prerequisite: Get an API Key

All MCP clients use the same Authorization Token, which is the API Key from the OpenViking console. Get it first and keep it secure.

1.1 Where to find it

  1. In the left menu, choose User Management.

  2. Find the target user in the user list. For personal editions, the default user is usually default / admin. Click the copy icon in the API Key column.

  3. Save the copied ZGV...hiMg string. It will be used as the Authorization value for agent integration.

Security note: The API Key is equivalent to an account secret. Do not commit it to Git or publish it anywhere. Prefer environment variables or encrypted configuration.

2. Cursor Integration Guide

This is the standard OpenViking flow for connecting Cursor.

2.1 Integration steps

Step 1 - Open settings

In the Cursor main window, click Settings in the upper-right corner to open the settings panel.

Step 2 - Add an MCP Server

In the left menu, select Tools & MCPs to open the MCP Servers page.

Click Add Custom MCP.

Step 3 - Paste the JSON configuration

In the opened mcp.json file, paste the following JSON and replace Authorization with the API Key copied in section 1:

json
{
  "mcpServers": {
    "ov-mcp-server": {
      "url": "https://api.vikingdb.cn-beijing.volces.com/openviking/mcp",
      "headers": {
        "Authorization": "Bearer ZGVmYXV********YzdlZjhiMg"
      }
    }
  }
}

Important: The Authorization value must include the Bearer prefix and a space. The full format is Bearer <API Key>.

Step 4 - Confirm and enable

After saving and closing mcp.json, Cursor automatically connects to the MCP server and loads the tools. When the connection succeeds, ov-mcp-server appears in the Installed MCP Servers list with the enabled tool count, such as "10 tools enabled". The switch next to ov-mcp-server should be green, which means the service is loaded and ready.

Step 5 - Check MCP connectivity

After connecting, run two simple queries in Cursor to verify the MCP server:

1. ov ls - List OpenViking root directories and confirm the connection returns the expected structure.

2. ov health - Call the health tool to confirm server status and current identity.

Acceptance criteria: ov ls returns directories such as agent / resources / session / user; ov health returns service initialized and the current username.

2.2 Configuration fields

FieldRequiredDescription
mcpServersYesRoot node for MCP server configuration
ov-mcp-serverYesService alias. It can be customized, but keeping this name helps contextual recognition
urlYesOpenViking MCP endpoint. For CN, use https://api.vikingdb.cn-beijing.volces.com/openviking/mcp
headers.AuthorizationYesFormat: Bearer <API Key>. Source: section 1

3. FAQ

ProblemSuggested fix
Connection failed / 401 UnauthorizedCheck that Authorization includes the Bearer prefix and that the API Key is valid
Connection failed / network timeoutConfirm the network can reach api.vikingdb.cn-beijing.volces.com; add an allowlist entry for corporate networks if needed
Agent cannot see toolsConfirm the MCP server is enabled. Some clients need a process restart before loading new config