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

ghl-mcp-server-v2

by zackscriven

ghl_agent_studio_update_metadata

Updates an agent's name, description, and status using a sub-account token, so you can keep GoHighLevel Agent Studio metadata accurate.

Instructions

Update Agent Metadata Updates agent metadata such as name, description, and status. Endpoint: PATCH /agent-studio/agent/{agentId} (Version header: v3; source: v3/agent-studio-v3.json) Requires a Sub-Account (location) token. OAuth scopes: agent-studio.write

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>",
      "body": "<body>"
    },
    "name": "ghl_agent_studio_update_metadata"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
sourceNoOrigin channel attributed to this write for auditing (e.g. public_api, internal)
agentIdYesAgent ID whose metadata is being updated

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv2.1.0
    • addedInput schema / properties / agentId / description
      Added value: +"Agent ID whose metadata is being updated"
    • addedInput schema / properties / body / title
      Added value: +"UpdatePublicAgentMetadataDTO"
    • addedInput schema / properties / source / description
      Added value: +"Origin channel attributed to this write for auditing (e.g. public_api, internal)"
  2. First observedv2.0.0

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare this is a non-read-only, non-destructive, non-idempotent, open-world mutation, so safety is largely covered. The description usefully adds auth requirements (Sub-Account token, agent-studio.write scope) and the concrete endpoint/version, but it never explains PATCH semantics — whether omitted body fields are left untouched or cleared — which matters for a partial-update tool.

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 purpose is front-loaded in the first two lines, followed by compact endpoint, auth, and scope metadata with no filler. The parenthetical version/source provenance is somewhat administrative, but it is a single clause and not disruptive.

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?

With a fully documented nested body schema, safety annotations, and no output schema, the description supplies what the structured fields cannot: endpoint path, required token type, and OAuth scope. The one remaining gap is the absence of any statement about partial-update behavior for fields omitted from the body.

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 body fields (name, status, description, locationId) and the source and agentId parameters are already documented in the schema. The description only restates the updatable field set and adds no syntax or constraint detail beyond what the schema provides, making the baseline 3 appropriate.

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?

The first two lines state a specific verb and resource — updating an agent's metadata (name, description, status) — which is clear enough on its own. It does not, however, differentiate itself from the nearby ghl_agent_studio_update_version sibling, leaving the agent to infer which update path applies to which fields.

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 implied by 'Updates agent metadata' plus the stated prerequisites (Sub-Account/location token, agent-studio.write scope), which is more than nothing. But there is no explicit when-to-use versus update_version, create, or promote_and_publish, and no statement of what this tool should not be used for.

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