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

ghl-mcp-server-v2

by zackscriven

ghl_agent_studio_get_by_id_deprecated

Read-onlyIdempotent

Retrieves a specific agent by ID and location, including all versions; deprecated—use the documented GET /agent-studio/agent/{agentId} replacement instead.

Instructions

Deprecated per official spec — use ghl_agent_studio_get_by_id (GET /agent-studio/agent/{agentId}) instead. [DEPRECATED per official docs — prefer the documented replacement if one exists.] Get Agent (Deprecated) Deprecated endpoint - use GET /agent/:agentId instead.

Gets a specific agent by its ID for the specified location with all its versions. locationId is required parameter. The agent must have active status. Endpoint: GET /agent-studio/public-api/agents/{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_deprecated"
  }
}

Input Schema

NameRequiredDescriptionDefault
sourceNoOrigin channel attributed to this read for auditing (e.g. public_api, internal)
agentIdYesManaged Agent ID
locationIdYesLocation ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv2.1.0
    • addedInput schema / properties / agentId / description
      Added value: +"Managed Agent ID"
    • addedInput schema / properties / locationId / description
      Added value: +"Location ID"
    • 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.4/5.0
Behavior5/5

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

Annotations already cover the safe read-only profile, but the description adds substantive context beyond them: endpoint path, version header, source specification, required token type, OAuth scope, and the active-status precondition. These details materially affect whether and how the tool can be called.

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

Conciseness2/5

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

Deprecation is announced in at least four separate places: the opening line, a bracketed note, the 'Get Agent (Deprecated)' line, and a bold sentence. The endpoint/source metadata is useful, but the repeated warnings and title restatement make the definition longer than necessary for a simple lookup.

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-only lookup with no output schema, the description supplies the replacement routing, auth requirements, OAuth scope, endpoint details, and active-status precondition. An agent has enough information to decide whether to avoid this tool or call it correctly if necessary.

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 meanings of agentId, locationId, and source are already documented in the schema. The description reinforces that locationId is required and adds the active-status precondition, but it does not explain the source parameter or add syntax beyond the schema; baseline 3 applies.

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 opening line names the exact operation and the replacement sibling, and the body confirms it retrieves a specific agent by ID for a location with all its versions. Despite repeated deprecation headings, an agent can distinguish this tool from ghl_agent_studio_get_by_id 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?

It explicitly says the tool is deprecated and directs the caller to use ghl_agent_studio_get_by_id instead. It also gives concrete prerequisites: locationId is required, the agent must have active status, and a Sub-Account token with agent-studio.readonly scope is needed.

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