Back to Openviking

Cursor

docs/images/agents/en/cursor.md

0.3.243.2 KB
Original Source

1. Cursor Integration Steps for OpenViking

Follow the steps below in Cursor to connect OpenViking:

Step 1: Open Cursor 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. The Authorization and other fields are already filled with the API Key value:

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

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, it is recommended to run two simple queries to verify the MCP server:

1. ov ls - List the OpenViking root directories to confirm the connection is available and the directory structure is returned correctly:

bash
ov ls

2. ov health - Call the health tool to confirm the OpenViking service status and current identity:

bash
ov health

Step 6: Acceptance criteria

ov ls returns directories such as agent / resources / session / user; ov health returns service initialized and the current username. This means the integration succeeded.

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>. Filled in during the steps above

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