Skip to main content
Glama

request_playbook_setup

Create a setup request for secrets and connections a playbook still needs, without collecting secret values in chat. Never ask the user to paste a secret value into chat. Use when verify_playbook or run_scratch_code reports missing secrets or disconnected integrations or MCP connectors. Without recipientEmail, returns setupUrl for the user to complete in the browser. With recipientEmail, emails that person the link instead and does not return the URL. Returns { needed: false } when nothing is missing. Links expire after 48 hours; a new link without recipientEmail invalidates the previous one.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "playbookId": "<playbookId>"
    },
    "name": "request_playbook_setup"
  }
}

Input Schema

NameRequiredDescriptionDefault
playbookIdYesPlaybook that needs secrets or connections.
recipientEmailNoEmail of someone else who should complete setup. Omit to get a link for the user you are working with.

Schema Changelog

Changes observed during successful MCP inspections.

No schema history has been recorded yet.

TDQS

A4.9/5.0
Behavior5/5

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

Annotations only declare readOnly=false, destructive=false, openWorld=true; the description goes far beyond by disclosing the two return modes (setupUrl vs. emailed link), the no-op case { needed: false }, the 48-hour expiry, and that a new link invalidates the previous one. That invalidation caveat is exactly the side effect an agent would otherwise get wrong.

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?

Front-loaded with the action and the safety rule, then the trigger conditions, then the return-value branches. No filler sentences; every clause carries operational 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?

There is no output schema, and the description compensates by describing all three return shapes and link lifetime. For a two-parameter, one-required tool this covers everything an agent needs to call it and interpret the result.

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 coverage is 100%, so both parameters are already documented. The description adds real meaning beyond the schema by tying recipientEmail to divergent return behavior and side effects (no URL returned, prior link invalidated), not just to input meaning.

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 ('Create a setup request for secrets and connections a playbook still needs') and immediately distinguishes itself from the read-only diagnostic siblings by explaining it solves the problem they report. An agent knows exactly what this produces 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?

Gives an explicit trigger ('Use when verify_playbook or run_scratch_code reports missing secrets or disconnected integrations or MCP connectors') naming the sibling tools that precede it, plus a hard prohibition ('Never ask the user to paste a secret value into chat') that shapes the whole interaction.

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