Skip to content

MCP Server


What is MCP Server?

MCP Server, Model Context Protocol (MCP), is an open protocol designed to standardize secure connections and data source access between applications and AI models. Its core goal is to enable developers to easily provide context information (such as data, content, operations) to models through unified "tools" and "resources," thereby enhancing model capabilities without the need to retrain the models.

Services built based on MCP Server ultimately provide a unified multi-model callable interface. This service supports multi-client access and adopts an API Key authentication mechanism to securely access the core functionalities of Guance, including monitors, logs, dashboards, and DQL queries.

Getting Started

Here, we take the Cherry Studio integration method as an example.

Integration Methods

More integration methods are under development. Stay tuned!

Download Version

  1. Download the MCP Server client Cherry Studio and select the corresponding version;

  2. Open Cherry Studio and start configuring the basic services for the large model.

Here, we take Volcengine as an example to configure the API key.

Configure Guance MCP Service

  1. Customize the service name and description;
  2. Select the type as streamableHttp;
  3. Define the URL: https://obsy-ai.guance.com/obsy_ai_mcp/mcp;
  4. The request header format is: Authorization=DF-API-KEY:Endpoint=SITE_KEY;
  5. After configuring the MCP service, save and enable it, then return to the homepage and select the MCP service.

Configuration Instructions

  • The interface uses API KEY as the authentication method. Each request uses the value of DF-API-KEY in the request body Header as the validity check and the workspace limit basis for this request (taking the workspace to which this DF-API-KEY belongs);

  • All interfaces currently displayed by the MCP service only require an API KEY (Header: DF-API-KEY) as a credential. If the credential exists and is valid, it is considered authenticated.

SITE_KEY_MAP = {
    # === China SaaS Deployment ===
    "cn1": "https://openapi.guance.com",        # China Region 1 (Hangzhou) — Default
    "cn2": "https://aws-openapi.guance.com",    # China Region 2 (Ningxia)
    "cn4": "https://cn4-openapi.guance.com",    # China Region 4 (Guangzhou)
    "cn6": "https://cn6-openapi.guance.one",    # China Region 6 (Hong Kong)
    "us1": "https://us1-openapi.guance.com",    # Overseas Region 1 (Oregon)
    "eu1": "https://eu1-openapi.guance.one",    # Europe Region 1 (Frankfurt)
    "ap1": "https://ap1-openapi.guance.one",    # Asia-Pacific Region 1 (Singapore)
    "za1": "https://za1-openapi.guance.com",    # Africa Region 1 (South Africa)
    "id1": "https://id1-openapi.guance.com",    # Indonesia Region 1 (Jakarta)
}

Call MCP Service

Tool Name
Function Input Example Notes
Monitor Management List monitors in Guance List monitors in Guance Default query returns the first 10 records
Log Data Access Rules List log data access rules in Guance List log data access rules in Guance Default query returns the first 10 records
Dashboard Management Get the list of dashboards in Guance Get the list of dashboards in Guance Default query returns the first 10 records
Log Query Execute DQL log query Logs from the last 15 minutes where service:mysql and status:error Default query returns all logs from the last 5 minutes
❗️Please follow a similar format for the query example, using structured "key:value" pairs for queries, avoiding natural language sentences

Feedback

Is this page helpful? ×