Skip to main content
Glama
ghl-mcp-server-v2

ghl-mcp-server-v2

by zackscriven

ghl_agent_studio_get_by_id

Read-onlyIdempotent

Retrieve a specific agent by ID and location to get complete metadata and all non-deleted versions (draft, staging, production) for an active sub-account agent.

Instructions

Get Agent Gets a specific agent by its ID for the specified location with all its versions. Returns complete agent metadata and all non-deleted versions (draft, staging, production). locationId is required parameter. The agent must have active status. Endpoint: GET /agent-studio/agent/{agentId} (Version header: v3; source: v3/agent-studio-v3.json) Requires a Sub-Account (location) token. OAuth scopes: agent-studio.readonly

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": {
      "agentId": "<agentId>",
      "locationId": "<locationId>"
    },
    "name": "ghl_agent_studio_get_by_id"
  }
}

Input Schema

NameRequiredDescriptionDefault
sourceNoOrigin channel attributed to this read for auditing (e.g. public_api, internal)
agentIdYesAgent ID to retrieve (returns metadata and all non-deleted versions)
locationIdYesLocation (sub-account) ID that owns the agent

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv2.1.0
    • addedInput schema / properties / agentId / description
      Added value: +"Agent ID to retrieve (returns metadata and all non-deleted versions)"
    • addedInput schema / properties / locationId / description
      Added value: +"Location (sub-account) ID that owns the agent"
    • addedInput schema / properties / source / description
      Added value: +"Origin channel attributed to this read for auditing (e.g. public_api, internal)"
  2. First observedv2.0.0

TDQS

A4.1/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/openWorld, and the description adds material context beyond them: the response includes all non-deleted versions, the target must be active, and the call needs a Sub-Account token with agent-studio.readonly scope. Auth and precondition disclosure is exactly what a caller needs before invoking.

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 core behavior is front-loaded and the endpoint/scope metadata is compact and skimmable. The opening "Get Agent" title line is a redundant restatement of the tool name, a minor bit of waste.

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?

For a read-by-ID tool with no output schema, the description covers return contents, required identifiers, status precondition, endpoint/version, and auth scope. Nothing essential for a correct call is missing.

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 coverage is 100%, so agentId, locationId, and source are already documented in the schema. The description only restates that locationId is required and that agentId returns versions, adding little syntax or semantics beyond the structured fields; 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 and resource ("Gets a specific agent by its ID") plus the returned scope ("complete agent metadata and all non-deleted versions (draft, staging, production)"). It does not distinguish itself from close siblings such as ghl_agent_studio_get_managed or ghl_agent_studio_get_by_id_deprecated, so an agent still has to infer which getter to use.

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?

Gives concrete preconditions: "locationId is required parameter", "The agent must have active status", and "Requires a Sub-Account (location) token." It stops short of explicit when-to-use/when-not guidance relative to the managed or deprecated getter siblings.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools