Skip to content
简体中文

Open Platform MCP

Open Platform MCP lets an agent read and analyze your organization's data in Caoliao: query metrics, inspect distributions, drill down from a number to the underlying records, and browse the objects themselves — QR codes, forms, batch templates and projects.

Once connected, the agent gets 15 tools in two groups:

  • Semantic analysis tools (7): built for analytical questions. The agent does not need to know Caoliao's data model — the tool responses tell it what business objects exist, which metrics can be computed, and which records make up each number.
  • Object browsing tools (8): mapped to OpenAPI V2 REST endpoints, answering "what does this object look like, and what is there" — dynamic QR code lists, subcodes under a template, projects in the organization.

Note: all tools are currently read-only. The agent cannot modify any business data in your organization. For writes (adding records, verifying certificates), use the OpenAPI V2 REST API.

Note: Caoliao also runs a Public MCP that needs no authentication and answers what is behind a single code. See Overview for how to choose.

Service details

ItemValue
Endpointhttps://open.cli.im/mcp
TransportStreamable HTTP
AuthenticationOAuth authorization (beta) or API Key (Bearer)
CapabilitiesData analysis + object browsing (read-only)

Two ways to authenticate

OAuth authorizationAPI Key
Best forUsers of office AI platforms such as WorkBuddy and QwenWorkDevelopers, system integration
You needA Caoliao account (beta: whitelist required)An API Key created on the Open Platform
SetupAdd the MCP, then sign in and confirm on the Caoliao authorization pagePut the Key in the client configuration
Credential scopeYou as a user + the organization you authorizeThe organization (a company credential)
RevocationRevoke that user's authorizationRotate the whole Key

Warning: two things to know before you start:

  • OAuth authorization is in beta. Your Caoliao account must be whitelisted first — to apply, sending them your Caoliao account (the phone number you sign in with).
  • With either method, the agent can see all data of the authorized organization. Scoping access to a single project is not supported yet (ignore this if your organization does not use projects).

Use in office AI platforms (OAuth)

If you use Caoliao data inside an office AI platform, follow the platform guide:

The flow is the same three steps everywhere: install (fastest: send the AI the message below and let it install itself) → sign in and confirm on the Caoliao authorization page → return to the platform and start chatting. No secret goes into the configuration:

Please install the Caoliao QR code MCP for me. The MCP server configuration is:
{
  "mcpServers": {
    "caoliao": {
      "type": "streamable-http",
      "url": "https://open.cli.im/mcp",
      "timeout": 60
    }
  }
}

If the AI cannot install it, add it manually per the platform guide — you paste the same JSON configuration embedded in the message.

Note: type uses streamable-http, the transport name from the official MCP registry. This field is interpreted locally by your client and is never sent to Caoliao; clients differ in what they expect (Cursor, VS Code and Claude Code use http). If a platform rejects the configuration, switch to the value in that platform's own documentation — the URL and everything else stays the same.

OAuth-capable developer clients (such as Claude Desktop remote connectors) work the same way: add https://open.cli.im/mcp and complete the authorization prompt, provided your account is whitelisted.

Use in developer clients (API Key)

This path is for developers and system integration. If you use Caoliao inside an office AI platform, use the OAuth authorization above — no API Key is needed.

The API Key is the same one created in Authentication (OpenAPI V2).

Manual configuration

Works in any client that supports mcpServers JSON configuration:

json
{
  "mcpServers": {
    "caoliao": {
      "type": "http",
      "url": "https://open.cli.im/mcp",
      "headers": {
        "Authorization": "Bearer <your API Key>"
      }
    }
  }
}

Note: the connector name (caoliao above) is up to you. Most clients use it as a tool-name prefix, e.g. caoliao_query_metrics — shorter names keep the tool list tidy.

Verify the connection

Restart the client after configuring. When the tool list shows Caoliao's 15 tools, you are connected. If the list is empty or you get a 401:

  • API Key: check the Key is valid and complete (a trailing = is part of the Key)
  • OAuth: confirm you completed the authorization page, and that your account is whitelisted

Tools

Note: this section is for developers and anyone who wants the details. If you are simply asking questions inside an office AI such as WorkBuddy or QwenWork, you do not need to memorize these tool names — the AI picks them for you. Skip to Next steps.

Semantic analysis tools (7)

For "how many / share / distribution / trend" questions, agents typically go list_metricsquery_metricsrecord_list: learn what exists, compute the numbers, then drill down to the records behind a number. Every response carries its calculation caliber and suggested next steps, so the agent can complete the chain on its own.

ToolPurpose
list_metricsEntry tool. Returns the organization's business object catalog (forms, projects, codes, periodic plans) and the currently computable metrics
get_metricFull definition of one metric: caliber, available dimensions, caveats
query_metricsCompute metrics. Supports grouping by form, project, code, handling progress, day and month, plus grouping by form field values and two-dimension cross grouping; every group result carries its own drill-down conditions
record_listRow summaries of records matching conditions (with reconstructed field names and values). Pass in the drill-down conditions from query_metrics verbatim to see the records behind a number
record_getFull content of a single record
qrcode_getContent of a single code
form_getForm structure: field names and option values — the key to reading record data. Accepts multiple form IDs for batch retrieval

Object browsing tools (8)

Mapped to OpenAPI V2 REST endpoints; see OpenAPI V2 for field semantics.

CategoryToolPurpose
Dynamic QR codesqrcodes_listList dynamic QR codes
Dynamic QR codesqrcodes_get_operationOperations linked to a code
Batch templatestemplates_listList batch templates
Batch templatestemplates_getBatch template structure
Batch templatestemplates_list_qrcodesSubcodes under a template
Batch templatestemplates_get_subcodeSubcode content
Formsrecord_get_form_listList forms
Projectsprojects_listList projects

Note: earlier versions exposed qrcodes_get_content, forms_get_template, record_get_record, record_get_records (superseded by qrcode_get, form_get, record_get, record_list) and the write tools record_add_record, certificates_verify. These 6 tools have been removed from the default tool surface; if an existing integration depends on them, .

Error codes are shared with V2; see Error codes.

Next steps