Skip to main content
Server path: /agent-management | Type: Embedded | PCID required: No

Tools

ToolDescription
agent_createCreate a new agent with specified configuration including name, description, instructions, tools, and resources. Two ways to add server tools: (1) Add all tools from a server: {“name”: “github”, “allTools”: true} — no need to list individual tools. (2) Add specific tools: call capabilities_discover to find relevant servers/tools, then list them in the tools field. Returns the created agent with its ID.
agent_updateUpdate an existing agent. Only provided fields will be updated - other fields remain unchanged. Requires the agent ID from create or read operations. Two ways to add server tools: (1) All tools from a server: {“name”: “github”, “allTools”: true}. (2) Specific tools: call capabilities_discover to find relevant servers/tools, then list them. Example: If user says “add all github tools”, use {“name”: “github”, “allTools”: true}.
agent_readGet detailed information about an agent including its configuration, tools, resources, and permissions. Use this to inspect an agent before updating it or to understand its capabilities.
agent_invokeInvoke an agent and get its response. Use this to leverage agent capabilities for data processing, decision making, or complex tasks. The agent can be invoked with a message and optionally continue a conversation using chatId. Returns the agent’s response, chatId for continuing conversations, and agentId.
agent_listList all agents accessible to the current user. Returns a summary of each agent including its ID, name, and description. Use this to discover available agents before invoking or updating them.
chat_createCreate a new chat session for an agent. A chat provides a persistent conversation context that maintains message history across multiple agent_invoke calls. After creating a chat, use agent_invoke with the returned chatId to send messages within this conversation.
chat_listList all chat sessions for a specific agent. Returns chat metadata including ID, name, agent association, and creation date. Use this to find existing conversations to resume via agent_invoke.
chat_reset_conversationReset a chat’s conversation history, clearing all messages. The chat itself is preserved but its message history is wiped clean. Use this to start a fresh conversation within an existing chat session. The next agent_invoke call with this chatId will behave as if the conversation just started.
chat_list_artifactsList all artifacts associated with a chat. Returns artifact metadata including IDs, names, MIME types, sizes, and download URLs. Artifacts are created by agents during code execution (via createArtifact) or uploaded by users.
agent_publish_releasePublish a release for an agent, locking in its current configuration as a versioned snapshot. A release is required before an agent can be made available as a public template. If nothing has changed since the last release, returns a message indicating nothing to release.
agent_toggle_public_templateToggle whether an agent is available as a public template in the template gallery. When enabling (available=true), the agent must have at least one published release. Provide a category and optional tags. When disabling (available=false), the agent is removed from the public gallery. Use agent_publish_release first to create a release before enabling.

agent_create

Create a new agent with specified configuration including name, description, instructions, tools, and resources. Two ways to add server tools: (1) Add all tools from a server: {“name”: “github”, “allTools”: true} — no need to list individual tools. (2) Add specific tools: call capabilities_discover to find relevant servers/tools, then list them in the tools field. Returns the created agent with its ID. Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesDisplay name for the agent
descriptionstringYesDescription of what the agent does
instructionsstringYesSystem instructions/prompt for the agent - guides the agent behavior and capabilities
outputSchemastringNoOptional JSON schema for agent output structure
promptExamplesstring[]No[]Example prompts shown as suggestion bubbles in the chat UI. These help users understand what the agent can do. Example: [“Analyze this RFP”, “Draft a response for this opportunity”]
selectedModelstringNoLLM model for the agent. If omitted, defaults to sonnet.
introMessagestringNoWelcome message shown when a user opens the agent chat for the first time.
serversanyNo[]MCP servers and tools to grant the agent access to. Two options per server: (1) All tools: {“name”: “github”, “allTools”: true} — includes every tool from the server. (2) Specific tools: {“name”: “google-drive”, “tools”: {“google-drive_list_files”: {}}} — call capabilities_discover to find relevant servers/tools first. Examples: [{“name”: “github”, “allTools”: true}, {“name”: “slack”, “tools”: {“slack_send_message”: {}}}]. For agents without any tool access, use empty array: []
resourcesany[]No[]Generic resources configuration (advanced use)
datastoresobject[]No[]NOT YET SUPPORTED. Granting datastore access during agent creation is not yet implemented. Do NOT use this field - inform the user this feature is coming soon.
filestoresobject[]No[]NOT YET SUPPORTED. Granting filestore access during agent creation is not yet implemented. Do NOT use this field - inform the user this feature is coming soon.
knowledgeBasesobject[]No[]NOT YET SUPPORTED. Granting knowledge base access during agent creation is not yet implemented. Do NOT use this field - inform the user this feature is coming soon.
workflowsobject[]No[]Workflows the agent can trigger
bindToWorkflowobjectNoOptionally bind this agent to a workflow immediately after creation. Agent will be available as a resource in the workflow for calling via config.callAgent(config.getAgent(“resourceName”))

agent_update

Update an existing agent. Only provided fields will be updated - other fields remain unchanged. Requires the agent ID from create or read operations. Two ways to add server tools: (1) All tools from a server: {“name”: “github”, “allTools”: true}. (2) Specific tools: call capabilities_discover to find relevant servers/tools, then list them. Example: If user says “add all github tools”, use {“name”: “github”, “allTools”: true}. Parameters:
ParameterTypeRequiredDefaultDescription
agentIdstringYesID of the agent to update (e.g. “ua_abc123”)
namestringNoUpdated display name for the agent
descriptionstringNoUpdated description of what the agent does
instructionsstringNoUpdated system instructions/prompt for the agent
outputSchemastringNoUpdated JSON schema for agent output structure
promptExamplesstring[]NoUpdated example prompts shown as suggestion bubbles in the chat UI.
selectedModelstringNoUpdated LLM model for the agent.
introMessagestringNoUpdated welcome message shown when a user opens the agent chat.
serversanyNoUpdated MCP servers and tools configuration. If provided, replaces existing servers completely. Use {“name”: “server”, “allTools”: true} to add all tools from a server, or call capabilities_discover to find specific tools. Example: [{“name”: “github”, “allTools”: true}, {“name”: “slack”, “tools”: {“slack_send_message”: {}}}]
resourcesany[]NoUpdated generic resources configuration
datastoresobject[]NoNOT YET SUPPORTED. Granting datastore access is not yet implemented. Do NOT use this field - inform the user this feature is coming soon.
filestoresobject[]NoNOT YET SUPPORTED. Granting filestore access is not yet implemented. Do NOT use this field - inform the user this feature is coming soon.
knowledgeBasesobject[]NoNOT YET SUPPORTED. Granting knowledge base access is not yet implemented. Do NOT use this field - inform the user this feature is coming soon.
workflowsobject[]NoUpdated workflows configuration

agent_read

Get detailed information about an agent including its configuration, tools, resources, and permissions. Use this to inspect an agent before updating it or to understand its capabilities. Parameters:
ParameterTypeRequiredDefaultDescription
agentIdstringYesID of the agent to retrieve (e.g. “ua_abc123”). Use this exact ID from create operation or from listing agents.

agent_invoke

Invoke an agent and get its response. Use this to leverage agent capabilities for data processing, decision making, or complex tasks. The agent can be invoked with a message and optionally continue a conversation using chatId. Returns the agent’s response, chatId for continuing conversations, and agentId. Parameters:
ParameterTypeRequiredDefaultDescription
agentIdstringYesID of the agent to invoke. Use agent_read or workflow_agents to see available agents.
messagestringYesThe message or task to send to the agent. Be clear and specific about what you need the agent to do.
chatIdstringNoOptional chat ID to continue a previous conversation. If provided, the conversation history will be loaded. If omitted, a new conversation will be started.
modestringNoOptional agent mode for routing. “action_agent” routes to GPT-based agent (default), “claude_agent” routes to Claude-based agent.
messagesInResponsebooleanNoIf true, includes the full message history in the response. Useful for debugging or reviewing conversation context.

agent_list

List all agents accessible to the current user. Returns a summary of each agent including its ID, name, and description. Use this to discover available agents before invoking or updating them. Parameters: None

chat_create

Create a new chat session for an agent. A chat provides a persistent conversation context that maintains message history across multiple agent_invoke calls. After creating a chat, use agent_invoke with the returned chatId to send messages within this conversation. Parameters:
ParameterTypeRequiredDefaultDescription
agentIdstringYesID of the agent to create a chat for (e.g. “ua_abc123”). The agent must already exist.
namestringNoOptional display name for the chat. If omitted, defaults to “Chat with agent <agentId>“.

chat_list

List all chat sessions for a specific agent. Returns chat metadata including ID, name, agent association, and creation date. Use this to find existing conversations to resume via agent_invoke. Parameters:
ParameterTypeRequiredDefaultDescription
agentIdstringYesAgent ID to list chats for. Required.

chat_reset_conversation

Reset a chat’s conversation history, clearing all messages. The chat itself is preserved but its message history is wiped clean. Use this to start a fresh conversation within an existing chat session. The next agent_invoke call with this chatId will behave as if the conversation just started. Parameters:
ParameterTypeRequiredDefaultDescription
chatIdstringYesID of the chat whose conversation history should be reset.

chat_list_artifacts

List all artifacts associated with a chat. Returns artifact metadata including IDs, names, MIME types, sizes, and download URLs. Artifacts are created by agents during code execution (via createArtifact) or uploaded by users. Parameters:
ParameterTypeRequiredDefaultDescription
chatIdstringYesID of the chat to list artifacts for.

agent_publish_release

Publish a release for an agent, locking in its current configuration as a versioned snapshot. A release is required before an agent can be made available as a public template. If nothing has changed since the last release, returns a message indicating nothing to release. Parameters:
ParameterTypeRequiredDefaultDescription
agentIdstringYesID of the agent to publish a release for (e.g. “ua_abc123”)

agent_toggle_public_template

Toggle whether an agent is available as a public template in the template gallery. When enabling (available=true), the agent must have at least one published release. Provide a category and optional tags. When disabling (available=false), the agent is removed from the public gallery. Use agent_publish_release first to create a release before enabling. Parameters:
ParameterTypeRequiredDefaultDescription
agentIdstringYesID of the agent to toggle template availability for
availablebooleanYestrue to make the agent available as a public template, false to remove it from the gallery
categorystringNoTemplate category (e.g. “sales”, “productivity”, “engineering”). Required when available=true.
publicTagsstring[]NoUp to 3 tags for the template (e.g. [“crm”, “analytics”]). Optional, only used when available=true. Tags are lowercased automatically.