Skip to main content
Glama

ap_setup_guide

ap_setup_guide
Read-only

Get setup instructions for connections or AI providers. Returns steps for the user to follow in the UI.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topicYesWhat to get setup instructions for
pieceNameNoFor connections: the piece that needs auth (e.g., "@activepieces/piece-gmail"). Omit for general instructions.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so safety is covered. The description adds one useful behavioral note — it returns instructions for the user rather than performing setup — but says nothing about format, length, or whether results vary by pieceName.

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?

Two short sentences with no filler, front-loading the action and then the return behavior. Slightly terse for a tool whose output semantics matter, but efficient.

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?

For a two-parameter read-only lookup with no output schema, the description tells the agent what it gets back (steps to follow) which is the key missing piece an output schema would otherwise provide. No annotations conflict; nothing critical is omitted.

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%, with both parameters documented in the schema including the enum and an example piece name. The description adds no syntax or format detail beyond the schema, so the baseline 3 applies.

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+resource: 'Get setup instructions for connections or AI providers,' and clarifies it returns steps for UI follow-up. It is distinguishable from siblings like ap_list_connections, though it does not name which sibling to use in ambiguous cases.

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?

Usage is only implied — an agent infers you call this when a user needs setup help for a connection or AI provider. There is no explicit when-to-use vs. alternative guidance, nor any mention of prerequisites or interactions with sibling 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