Skip to main content
Glama
Sign In

Convocore

by app.convocore.mcp
OverviewDiscussionsAdmin

get_ui_engine_spec

Read-onlyIdempotent

Return the FULL Convocore UI Engine schema (the structured message format agents emit when vg_enableUIEngine: true). ALWAYS CALL THIS FIRST when: (a) testing a UI-Engine-enabled agent via interact_with_agent and you need to validate the output, OR (b) creating / updating an agent that should produce UI Engine output (so the system prompt teaches the LLM to emit valid text / choice / visual / cardV2 / carousel / iFrame / form / input / invoice / calendarBooking messages). Also documents agent feature flags (vg_enableUIEngineForms, vg_enableUIEngineInvoice, vg_enableUIEngineCalendarBooking, vg_uiEngineChannelConfig) used by update_agent to allow/deny which UI elements the agent may show. Returns: meta (streaming + channel-gating + agentFeatureFlags), envelopes (TurnProps / ChatMessage), messageTypes, shared types, rules, and a validationChecklist. Use section to narrow the response: "meta" | "envelopes" | "message_types" | "shared" | "rules" | "checklist" | "primer" | "all" (default). Use messageType to drill into a single message-type schema (e.g. "choice" or "form"). Static knowledge — does NOT hit the API and does NOT consume credits.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_ui_engine_spec"
  }
}

Input Schema

NameRequiredDescriptionDefault
sectionNoWhich slice of the spec to return. Default: "all".
messageTypeNoWhen set, return only the schema for this message type (overrides section). Use when you only need one shape.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Goes well beyond the annotations by disclosing the return payload structure (meta, envelopes, messageTypes, shared types, rules, validationChecklist) and the crucial operational fact that it is static knowledge that does not hit the API or consume credits. Annotations already cover read-only/idempotent safety, and the description adds cost and output-shape context that is genuinely new.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Dense and front-loaded: the core purpose leads, the when-to-use conditions follow, and the parameter/return notes come last. It is somewhat long and the enumerated message types inside parentheses are a bit list-heavy, but nearly every clause carries actionable information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description compensates by enumerating the exact sections returned and the narrowing options. Combined with the static/no-credit note, an agent has everything needed to invoke this correctly and interpret the response without follow-up calls.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% with both parameters enumerated, so the baseline is satisfied. The description adds meaning the schema does not: it spells out the valid `section` values in prose and explicitly notes that `messageType` overrides `section`, a precedence rule absent from the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource (return the full Convocore UI Engine schema) and immediately disambiguates it from siblings like get_channel_integration_spec or get_widget_css_styling_guide by naming the exact message types covered. An agent can identify this tool's scope without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly names two triggering conditions ('ALWAYS CALL THIS FIRST when: (a) testing ... via interact_with_agent ... OR (b) creating / updating an agent ...') and references the sibling tools involved. This is when-to-use guidance in its strongest form, including the ordering requirement relative to other calls.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Convocore toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources