Agent Studio Execute Agent

Immutable Catalog Entry

This descriptor comes from the active versioned Portal catalog.

WRITEghl.agent_studio_execute_agent

• Contract tier: agent_ready
• Risk: write
• Catalog version: 2026-07-12.2
• Descriptor hash: cc2903de39fc92b71927d8ac1b937bc23f1cb62e242f8d82855960d2411577d4

Execute an active GHL AI Agent Studio agent and return its non-streaming JSON output. GHL category: AI Agents / AI Agent Studio. This writes to or executes GHL AI Agent Studio configuration. Do not modify, publish, or execute production agents during validation unless the user explicitly provides disposable fixtures.

Request Body

{
  "jsonrpc": "2.0",
  "id": "ghl-agent-studio-execute-agent-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.agent_studio_execute_agent",
    "arguments": {
      "agentId": "agentId_123",
      "body": {},
      "query": {},
      "tenantId": "tenantId_123",
      "locationId": "locationId_123",
      "strictTenant": false,
      "includeFullConfig": false
    }
  }
}

Arguments Schema

{
  "type": "object",
  "required": [
    "agentId",
    "body"
  ],
  "properties": {
    "body": {
      "type": "object",
      "properties": {
        "input": {
          "type": "string",
          "description": "User input to send to the active agent."
        },
        "variables": {
          "type": "object",
          "description": "Optional execution variables.",
          "additionalProperties": true
        }
      },
      "description": "Request body for executing an Agent Studio agent. locationId is injected automatically.",
      "additionalProperties": true
    },
    "query": {
      "type": "object",
      "description": "Optional GHL-supported query parameters for this official Agent Studio endpoint, such as limit, offset, isPublished, or documented filters. locationId is injected automatically for list/get endpoints that require it.",
      "additionalProperties": true
    },
    "agentId": {
      "type": "string",
      "description": "agentId path parameter required by /agent-studio/agent/:agentId/execute."
    },
    "tenantId": {
      "type": "string",
      "description": "Tenant ID from list_tenants."
    },
    "locationId": {
      "type": "string",
      "description": "Optional GHL location ID. If provided, it must match the authenticated runtime location; otherwise the runtime location is injected as the required body locationId."
    },
    "strictTenant": {
      "type": "boolean",
      "default": true,
      "description": "Require tenantId to match locationId routing (default: true)."
    },
    "includeFullConfig": {
      "type": "boolean",
      "description": "Defaults to false. Set true only when the user explicitly needs full Agent Studio prompts, version graph data, instructions, nodes, or execution configuration."
    }
  },
  "additionalProperties": false
}

Output Schema

{
  "type": "object",
  "required": [
    "ok",
    "data",
    "error",
    "meta"
  ],
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Whether the GHL MCP operation completed successfully."
    },
    "data": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "array",
          "items": {}
        },
        {
          "type": "string"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "description": "Tool-specific GHL or local navigation result when ok is true."
    },
    "meta": {
      "type": "object",
      "description": "Safe execution, routing, and timing metadata.",
      "additionalProperties": true
    },
    "error": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ],
      "description": "Safe error details when ok is false; credential values are never returned."
    }
  },
  "description": "Normalized GHL MCP response envelope.",
  "additionalProperties": false
}

Code Examples

cURL

curl -X POST 'https://portal.madpanda3d.com/api/mcp' \
  -H 'Authorization: Bearer mad_live_***' \
  -H 'Content-Type: application/json' \
  -d '{
  "jsonrpc": "2.0",
  "id": "ghl-agent-studio-execute-agent-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.agent_studio_execute_agent",
    "arguments": {
      "agentId": "agentId_123",
      "body": {},
      "query": {},
      "tenantId": "tenantId_123",
      "locationId": "locationId_123",
      "strictTenant": false,
      "includeFullConfig": false
    }
  }
}'

Node.js

const response = await fetch('https://portal.madpanda3d.com/api/mcp', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer mad_live_***',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "jsonrpc": "2.0",
  "id": "ghl-agent-studio-execute-agent-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.agent_studio_execute_agent",
    "arguments": {
      "agentId": "agentId_123",
      "body": {},
      "query": {},
      "tenantId": "tenantId_123",
      "locationId": "locationId_123",
      "strictTenant": false,
      "includeFullConfig": false
    }
  }
}),
});
const data = await response.json();
console.log(data);

Python

import requests

url = 'https://portal.madpanda3d.com/api/mcp'
headers = {
    'Authorization': 'Bearer mad_live_***',
    'Content-Type': 'application/json',
}
payload = {
  "jsonrpc": "2.0",
  "id": "ghl-agent-studio-execute-agent-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.agent_studio_execute_agent",
    "arguments": {
      "agentId": "agentId_123",
      "body": {},
      "query": {},
      "tenantId": "tenantId_123",
      "locationId": "locationId_123",
      "strictTenant": false,
      "includeFullConfig": false
    }
  }
}
response = requests.post(url, headers=headers, json=payload, timeout=60)
print(response.json())

Example Responses

200 Success

{
  "ok": true,
  "message": "Tool ghl.agent_studio_execute_agent executed successfully.",
  "note": "Response shape varies by MCP tool. Inspect live responses for exact fields."
}

502 Upstream Error

{
  "ok": false,
  "classification": "upstream_http_error",
  "message": "Upstream MCP returned a non-success status."
}