Skip to main content
Glama

Target setup guide

get_setup_guide
Read-onlyIdempotent

How to register an agent target: the create_target workflow (list → dedup → create → iterate on categorized probe errors), a field-by-field config reference generated from the live schema, the semantics the schema can't express (dot-paths, request-body template, streaming modes, session capture), and worked examples for HTTP, SSE-streaming, and WebSocket endpoints. Read this before your first create_target. Requires the read scope.

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds useful context: the guide content is generated from the live schema and requires the read scope, though it does not discuss response size or formatting beyond the output schema.

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?

The description is a single dense sentence that front-loads the primary purpose before enumerating contents. It is appropriately sized for a guide tool, though the long enumeration is slightly run-on and could be structured more scannably.

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?

With an output schema present, the description need not explain return values. It covers purpose, contents, prerequisite scope, and when to use it, which is complete for a zero-parameter documentation tool.

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?

The tool has zero parameters, so the baseline is 4 per the rubric. The description does not need to explain parameter syntax and appropriately focuses on the guide contents instead.

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?

The description states exactly what the tool returns: a setup guide covering the create_target workflow, config reference, schema-unexpressible semantics, and worked examples. It clearly names the resource and scope, and references create_target, distinguishing it from sibling mutation/list tools.

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?

It explicitly says 'Read this before your first create_target' and states the read-scope requirement. This gives the agent a clear when-to-use trigger and a prerequisite, with no ambiguity about alternatives.

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