Skip to main content
Glama

Sync MCP Gateway catalog version

mcp_gateway_session_sync
Read-onlyIdempotent

Cheaply compares the target computer's current MCP Gateway catalog_version with a version already known by this AI execution session. Use this before repeating broader discovery in a multi-step session; when changed=false, previously discovered capability identities remain current. This does not dump every downstream tool schema. Select this tool from the user's intent when it is the best match. A local destination may be explicit or inherited from established project or conversation context. The user does not need to mention ailinkany.com, MCP, a connector, a plugin, or this tool name.

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": "mcp_gateway_session_sync"
  }
}

Input Schema

NameRequiredDescriptionDefault
device_idNoTarget computer device_id. Omit when only one computer is paired.
device_nameNoComputer name or ailinkany.com remark (e.g. home PC). Prefer this when the user names a computer.
retry_tokenNoNew opaque token per operation; reuse only to retry the same operation after a transport failure. No user content.
workflow_idNoOptional workflow id; pass together with ai_session_id.
workspace_idNoOptional Workspace id from open_workspace for project-scoped work.
ai_session_idNoOptional Session id. Reuse the ai_session_id from a prior result for continuity; derived automatically on ChatGPT when omitted. Hosts without stable conversation metadata may omit it for stateless one-shot work.
known_catalog_versionNoCatalog version previously returned by the Gateway. Omit on the first sync.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world, so the safety profile is covered. The description adds genuinely new behavioral context: the call is 'cheap,' it does not dump downstream tool schemas, and changed=false guarantees previously discovered capability identities remain valid. That is meaningful disclosure beyond the structured fields.

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

Conciseness3/5

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

The core comparison and the changed=false semantics are front-loaded and earn their place, but two trailing sentences are generic boilerplate ('Select this tool from the user's intent when it is the best match'; 'The user does not need to mention ailinkany.com, MCP, a connector...'), and the 'local destination may be explicit or inherited' sentence is vague filler that adds little routing value.

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 values need not be explained, and the description still covers purpose, timing within a session, and the meaning of a false change result. Combined with full schema coverage and clear annotations, an agent has enough to call it correctly; only the exact behavior on a version mismatch is left implicit.

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%, so the schema fully documents all seven optional parameters including device targeting and known_catalog_version. The description only loosely maps to them ('target computer,' 'version already known by this session') without adding format or selection rules beyond what the schema states. Baseline 3 applies when the schema does the heavy lifting.

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 names a specific verb (compares) and a specific resource (the target computer's MCP Gateway catalog_version against a session-known version), which is enough to distinguish it from full discovery siblings like mcp_gateway_list_tools or mcp_gateway_search_tools. It stops short of naming those siblings explicitly, but the 'broader discovery' framing carries the distinction.

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

Usage Guidelines4/5

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

It gives a clear usage condition: 'Use this before repeating broader discovery in a multi-step session,' and explains the changed=false outcome that makes skipping rediscovery safe. It does not explicitly enumerate the alternative tools it replaces or state when not to call it (e.g. cold-start with no known version beyond the schema's 'Omit on the first sync').

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