On this page

get-agent

Read one agent from the Orchestrate Agents registry by its agent_id (the id list-agents and create-agent return, and the one the console shows in its URL). Returns the agent's title, role, description, model, skills, context tags and knowledge-base setting. For a multi-agent process flow use get-process-flow instead.

What it is called on each surface

The wire name is get-agent everywhere: it is what the Wexa MCP server advertises, the REST path is POST /v1/get-agent, and each SDK exposes it under its own language's naming convention.

SurfaceName
Wexa MCP serverget-agent
REST APIPOST /v1/get-agent
TypeScript SDKfabric.getAgent()
Python SDKfabric.get_agent()

Arguments

1 of the 1 argument is required. Omitting a required one is refused before the tool runs, at the validation stage, so it costs nothing and changes nothing.

ArgumentTypeRequiredNotes
agent_idstringRequiredAgent id from list-agents, create-agent or the console URL.

project_id, projectID, organization_id and executed_by are not arguments you pass: the platform binds all four from the credential you authenticated with, and both SDKs refuse them before the request leaves your process — see server-bound arguments.

What it returns

The three surfaces wrap this differently, and code written against one will not read another correctly — see return shape.

A real response, captured from a live call to get-agent:

{
  "content": [
    {
      "type": "text",
      "text": "{\"lifecycle_id\":\"qlc_000175\",\"result\":{\"agent_id\":\"6ab1945e7566f41b5c28e303.6ab1945e83ff5845d7db96bc\",\"context\":[],\"description\":\"A stable agent the documentation cites.\",\"has_knowledge_base\":false,\"is_promoted\":false,\"model\":\"system_model\",\"prompt\":{\"display_template\":\"Reply with READY.\",\"template\":\"Reply with READY.\",\"variables\":[]},\"role\":\"tester\",\"role_description\":\"A stable agent the documentation cites.\",\"skills\":[],\"title\":\"docs-fixture-agent\",\"triggers\":[]}}"
    }
  ],
  "isError": false
}

Keeping the lifecycle_id is what lets you ask later why a call was allowed, refused or held.

Calling it

The same call on all four surfaces. Pick a tab once and every code block in the documentation follows it.

The ids in this example are real: they resolve against the project the documentation is written against, so the call runs as written once you point it at your own deployment. Swap them for the ids of your own objects.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get-agent",
    "arguments": {
      "agent_id": "6ab1945e7566f41b5c28e303.6ab1945e83ff5845d7db96bc"
    }
  }
}

Errors

Both SDKs raise the same typed errors, chosen from the gateway's own error string first and its HTTP status second. get-agent checks the fabric:orchestrate.read grant, and reaches the seven classes every tool reaches — listed under the common set. These are the ones specific to it:

ErrorStatusRaised when
NotFound404agent_id matches no agent in this project.
ConfigurationError5xxget-agent is not available to you. Retrying will not help.

Governance

Every call to get-agent runs through the same ten-stage lifecycle as every other Wexa tool: the credential is resolved to a scope, the fabric:orchestrate.read grant is checked, quota is drawn down, the arguments are validated, policy rules are evaluated, the call is executed, the result is shaped and redacted, and an audit record is written. The lifecycle_id in the response is the handle to that record.

get-agent only reads, so it is not marked consequential: it is audited lightly and is never held for approval. It still consumes quota and is still refused by policy like anything else.

See also

The tool index, errors, and which identifier goes where.