Skip to main content
Glama

Communicate Developer Docs

Get Communicate OpenAPI summary

communicate_get_openapi_summary
Read-onlyIdempotent

Return the canonical OpenAPI URL, API base URL, authentication boundary, and currently published REST operations without calling the authenticated API.

Input Schema

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

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleYes
apiBaseUrlYes
openapiUrlYes
operationsYes
authenticationYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare read-only, idempotent, non-destructive, and closed-world behavior. The description adds valuable context beyond the annotations by clarifying that no authenticated API call is made and that the authentication boundary is returned as part of the summary.

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?

The description is a single, well-structured sentence that front-loads the returned artifacts and ends with the no-auth constraint. Every phrase earns it place.

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?

This is a low-complexity documentation summary tool with a full output schema and safety annotations already in place. The description lists the returned artifacts and the key behavioral constraint, making it complete enough for an agent to invoke correctly.

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?

The single optional query parameter is fully described in the input schema, including the note that the complete summary is always returned. The description does not add syntax or semantics beyond what the schema already provides, so the baseline score for high schema coverage is appropriate.

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?

The description uses a specific verb ("Return") and names the exact resources returned: canonical OpenAPI URL, API base URL, authentication boundary, and published REST operations. It clearly distinguishes the tool's content from sibling documentation tools, but it does not explicitly reference alternatives like communicate_get_developer_guide or communicate_get_support_contact.

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

Usage Guidelines3/5

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

There is no explicit when-to-use or when-not-to-use guidance. The phrase "without calling the authenticated API" implies this is useful for unauthenticated documentation lookups, but the description does not state when an agent should choose this over the sibling documentation tools.

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