Skip to main content
Glama

Communicate Developer Docs

Get Communicate developer guide

communicate_get_developer_guide
Read-onlyIdempotent

Return the canonical Communicate API URLs, authentication boundary, and support contact. This tool is public, read-only, and never accesses workspace or customer data.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryNoOptional keyword describing the documentation focus. The complete canonical summary is always returned.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleYes
docsUrlYes
summaryYes
supportYes
apiBaseUrlYes
openapiUrlYes
markdownUrlYes
authenticationYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint=false, so the description's 'read-only' restatement earns little. However, 'never accesses workspace or customer data' is a genuine data-boundary disclosure beyond the structured annotations and is valuable for an agent deciding whether the call is safe. It stops short of describing output size or rate behavior.

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

Conciseness5/5

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

Two compact sentences with the payload listed first and the safety note second; every clause carries information and nothing is padded.

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

Completeness4/5

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

An output schema exists, so return-value detail is unnecessary, and the description summarizes the returned content well. For a zero-required-parameter, read-only tool the definition is nearly complete; only the overlap with the support-contact sibling is unaddressed.

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

Parameters3/5

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

Schema description coverage is 100% and the single 'query' parameter is well documented in the schema itself, including that the full canonical summary is always returned. The description adds no parameter detail at all, so this is the baseline 3 with the schema doing all the work.

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

Purpose4/5

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

States a specific verb ('Return') and enumerates the concrete payload: canonical API URLs, authentication boundary, and support contact. It is clear in isolation, but it does not differentiate itself from the sibling communicate_get_support_contact, even though it also returns support contact info.

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

Usage Guidelines2/5

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

The second sentence describes the tool's safety posture ('public, read-only, never accesses workspace or customer data') rather than when to call it. There is no statement of when this is preferable to communicate_get_openapi_summary or communicate_get_support_contact, leaving selection to inference.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources