Archestra MCP Server
The Archestra MCP Server is a built-in MCP server that ships with the platform and requires no installation. It exposes tools for managing platform resources such as agents, MCP servers, policies, and limits.
Most tools require explicit assignment to Agents or MCP Gateways before they can be used. The following tools are pre-installed on all new agents by default: artifact_write, todo_write.
Additionally, query_knowledge_sources is automatically assigned to Agents and MCP Gateways that have at least one knowledge base or knowledge connector attached.
All Archestra tools are prefixed with archestra__ and are always trusted — they bypass tool invocation and trusted data policies.
Auth
Archestra tools are trusted, meaning they bypass tool invocation policies and trusted data policies — the tool will always execute without policy evaluation.
However, RBAC (role-based access control) is still enforced. Every tool is mapped to a required permission (resource + action). The tools/list endpoint dynamically filters tools so users only see tools they have permission to use. For example, a user without knowledgeBase:create permission will not see create_knowledge_base in their tool list and cannot execute it.
Tools Reference
Identity
| Tool | Description |
|---|---|
whoami | Returns the name and ID of the current agent. |
whoami
This tool takes no arguments.
Output
| Field | Type | Required | Description |
|---|---|---|---|
agentId | string | Yes | The ID of the current agent. |
agentName | string | Yes | The display name of the current agent. |
Agents
| Tool | Description |
|---|---|
create_agent | Create a new agent with the specified name, optional description, labels, prompts, icon emoji, MCP server tool assignments, and sub-agent delegations. |
get_agent | Get a specific agent by ID or name. |
list_agents | List agents with optional filtering by name and scope. |
edit_agent | Edit an existing agent. |
create_agent
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name for the new resource. |
scope | "personal" | "team" | "org" | No | Visibility scope. Defaults to personal for agents and org for LLM proxies/MCP gateways unless teams are provided. |
labels | object[] | No | Optional key-value labels for organization and categorization. |
labels[].key | string | Yes | |
labels[].value | string | Yes | |
teams | string[] | No | Team IDs to attach when creating a team-scoped resource. |
description | any | No | Optional human-readable description of the agent. |
icon | any | No | Optional emoji icon for the agent. |
knowledgeBaseIds | string[] | No | Knowledge base IDs to assign to the agent. Use get_knowledge_bases first when you need to look up IDs by name. |
connectorIds | string[] | No | Knowledge connector IDs to assign directly to the agent. Use get_knowledge_connectors first when you need to look up IDs by name. |
mcpServerIds | string[] | No | Catalog item IDs from get_mcp_servers whose tools should be assigned to the agent. |
subAgentIds | string[] | No | Agent IDs to delegate to from this newly created agent. |
suggestedPrompts | object[] | No | Optional suggested prompts that appear in the chat UI. |
suggestedPrompts[].summaryTitle | string | Yes | Short title shown to users for this suggested prompt. |
suggestedPrompts[].prompt | string | Yes | Suggested prompt text users can click to start a conversation. |
systemPrompt | any | No | The system prompt that defines the agent's behavior. |
toolAssignments | object[] | No | Explicit tool assignments to create immediately after the agent is created. |
toolAssignments[].toolId | string | Yes | The ID of the tool to assign to the agent. |
toolAssignments[].credentialSourceMcpServerId | any | No | For remote MCP tools, the deployed MCP server ID that should supply credentials. |
toolAssignments[].executionSourceMcpServerId | any | No | For local MCP tools, the deployed MCP server ID that should execute the tool. |
toolAssignments[].useDynamicTeamCredential | boolean | No | When true, resolve credentials dynamically from the invoking team instead of pinning a deployment. |
get_agent
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | No | The ID of the agent to fetch. Prefer the ID when you already have it. |
name | string | No | The exact name of the agent to fetch when you do not already have the ID. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The resource ID. |
name | string | Yes | The resource name. |
description | any | Yes | The resource description, if any. |
icon | any | Yes | The emoji icon, if configured. |
scope | "personal" | "team" | "org" | Yes | The visibility scope. |
agentType | "agent" | "llm_proxy" | "mcp_gateway" | "profile" | Yes | The resource type. |
systemPrompt | any | No | |
teams | object[] | Yes | The teams attached to it. |
teams[].id | string | Yes | The team ID. |
teams[].name | string | Yes | The team name. |
labels | object[] | Yes | Assigned labels. |
labels[].key | string | Yes | The label key. |
labels[].value | string | Yes | The label value. |
tools | object[] | Yes | Assigned tools. |
tools[].id | string | Yes | The assigned tool ID. |
tools[].name | string | Yes | The tool name. |
tools[].description | any | Yes | The tool description, if any. |
tools[].catalogId | any | Yes | The MCP catalog ID the tool comes from, if any. |
knowledgeBaseIds | string[] | Yes | Assigned knowledge base IDs. |
connectorIds | string[] | Yes | Assigned knowledge connector IDs. |
suggestedPrompts | object[] | Yes | Configured suggested prompts. |
suggestedPrompts[].summaryTitle | string | Yes | The short title shown in the chat UI. |
suggestedPrompts[].prompt | string | Yes | The suggested prompt text. |
list_agents
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Maximum number of agents to return. |
name | string | No | Optional agent name filter. Use this when the user names an agent but you still need to look up the ID. |
scope | "personal" | "team" | "org" | No | Optional scope filter: personal, team, or org. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
total | number | Yes | The total number of matching agents. |
agents | object[] | Yes | |
agents[].id | string | Yes | The agent ID. |
agents[].name | string | Yes | The agent name. |
agents[].scope | "personal" | "team" | "org" | Yes | The agent scope. |
agents[].description | any | Yes | The agent description, if any. |
agents[].teams | object[] | Yes | Teams attached to it. |
agents[].teams[].id | string | Yes | The team ID. |
agents[].teams[].name | string | Yes | The team name. |
agents[].labels | object[] | Yes | Assigned labels. |
agents[].labels[].key | string | Yes | The label key. |
agents[].labels[].value | string | Yes | The label value. |
agents[].tools | object[] | Yes | |
agents[].tools[].name | string | Yes | The tool name. |
agents[].tools[].description | any | Yes | The tool description, if any. |
agents[].knowledgeSources | object[] | Yes | Assigned knowledge bases and connectors. |
agents[].knowledgeSources[].name | string | Yes | The knowledge source name. |
agents[].knowledgeSources[].description | any | Yes | The knowledge source description, if any. |
agents[].knowledgeSources[].type | "knowledge_base" | "knowledge_connector" | Yes | Whether this source is a knowledge base or connector. |
edit_agent
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the agent to edit. Use get_agent or list_agents to look it up by name. |
mcpServerIds | string[] | No | Catalog item IDs from get_mcp_servers whose tools should be added to the agent. |
subAgentIds | string[] | No | Agent IDs to add as delegation targets. |
toolAssignments | object[] | No | Explicit tool assignments to add or update on the agent. |
toolAssignments[].toolId | string | Yes | The ID of the tool to assign to the agent. |
toolAssignments[].credentialSourceMcpServerId | any | No | For remote MCP tools, the deployed MCP server ID that should supply credentials. |
toolAssignments[].executionSourceMcpServerId | any | No | For local MCP tools, the deployed MCP server ID that should execute the tool. |
toolAssignments[].useDynamicTeamCredential | boolean | No | When true, resolve credentials dynamically from the invoking team instead of pinning a deployment. |
description | any | No | New description for the agent. |
icon | any | No | New emoji icon for the agent. |
knowledgeBaseIds | string[] | No | Replace the agent's assigned knowledge bases with this set. |
labels | object[] | No | Replace the agent's labels with this set. |
labels[].key | string | Yes | |
labels[].value | string | Yes | |
name | string | No | New name for the agent. |
connectorIds | string[] | No | Replace the agent's directly assigned knowledge connectors with this set. |
scope | "personal" | "team" | "org" | No | Updated visibility scope for the agent. |
suggestedPrompts | object[] | No | Replace the agent's suggested prompts. |
suggestedPrompts[].summaryTitle | string | Yes | Short title shown to users for this suggested prompt. |
suggestedPrompts[].prompt | string | Yes | Suggested prompt text users can click to start a conversation. |
systemPrompt | any | No | New system prompt for the agent. |
teams | string[] | No | Replace the teams attached to a team-scoped agent. |
LLM Proxies
| Tool | Description |
|---|---|
create_llm_proxy | Create a new LLM proxy with the specified name and optional labels. |
get_llm_proxy | Get a specific LLM proxy by ID or name. |
edit_llm_proxy | Edit an existing LLM proxy. |
create_llm_proxy
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name for the new resource. |
scope | "personal" | "team" | "org" | No | Visibility scope. Defaults to personal for agents and org for LLM proxies/MCP gateways unless teams are provided. |
labels | object[] | No | Optional key-value labels for organization and categorization. |
labels[].key | string | Yes | |
labels[].value | string | Yes | |
teams | string[] | No | Team IDs to attach when creating a team-scoped resource. |
get_llm_proxy
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | No | The ID of the LLM proxy to fetch. Prefer the ID when you already have it. |
name | string | No | The exact name of the LLM proxy to fetch when you do not already have the ID. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The resource ID. |
name | string | Yes | The resource name. |
description | any | Yes | The resource description, if any. |
icon | any | Yes | The emoji icon, if configured. |
scope | "personal" | "team" | "org" | Yes | The visibility scope. |
agentType | "agent" | "llm_proxy" | "mcp_gateway" | "profile" | Yes | The resource type. |
systemPrompt | any | No | |
teams | object[] | Yes | The teams attached to it. |
teams[].id | string | Yes | The team ID. |
teams[].name | string | Yes | The team name. |
labels | object[] | Yes | Assigned labels. |
labels[].key | string | Yes | The label key. |
labels[].value | string | Yes | The label value. |
tools | object[] | Yes | Assigned tools. |
tools[].id | string | Yes | The assigned tool ID. |
tools[].name | string | Yes | The tool name. |
tools[].description | any | Yes | The tool description, if any. |
tools[].catalogId | any | Yes | The MCP catalog ID the tool comes from, if any. |
knowledgeBaseIds | string[] | Yes | Assigned knowledge base IDs. |
connectorIds | string[] | Yes | Assigned knowledge connector IDs. |
suggestedPrompts | object[] | Yes | Configured suggested prompts. |
suggestedPrompts[].summaryTitle | string | Yes | The short title shown in the chat UI. |
suggestedPrompts[].prompt | string | Yes | The suggested prompt text. |
edit_llm_proxy
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the LLM proxy to edit. Use get_llm_proxy to look it up by name first if needed. |
description | any | No | New description for the LLM proxy. |
icon | any | No | New emoji icon for the LLM proxy. |
labels | object[] | No | Replace the LLM proxy's labels with this set. |
labels[].key | string | Yes | |
labels[].value | string | Yes | |
name | string | No | New name for the LLM proxy. |
scope | "personal" | "team" | "org" | No | Updated visibility scope for the LLM proxy. |
teams | string[] | No | Replace the teams attached to a team-scoped LLM proxy. |
MCP Gateways
| Tool | Description |
|---|---|
create_mcp_gateway | Create a new MCP gateway with the specified name, optional labels, and optional assigned knowledge bases or knowledge connectors. |
get_mcp_gateway | Get a specific MCP gateway by ID or name. |
edit_mcp_gateway | Edit an existing MCP gateway. |
create_mcp_gateway
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name for the new resource. |
scope | "personal" | "team" | "org" | No | Visibility scope. Defaults to personal for agents and org for LLM proxies/MCP gateways unless teams are provided. |
labels | object[] | No | Optional key-value labels for organization and categorization. |
labels[].key | string | Yes | |
labels[].value | string | Yes | |
teams | string[] | No | Team IDs to attach when creating a team-scoped resource. |
knowledgeBaseIds | string[] | No | Knowledge base IDs to assign to the agent. Use get_knowledge_bases first when you need to look up IDs by name. |
connectorIds | string[] | No | Knowledge connector IDs to assign directly to the agent. Use get_knowledge_connectors first when you need to look up IDs by name. |
get_mcp_gateway
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | No | The ID of the MCP gateway to fetch. Prefer the ID when you already have it. |
name | string | No | The exact name of the MCP gateway to fetch when you do not already have the ID. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The resource ID. |
name | string | Yes | The resource name. |
description | any | Yes | The resource description, if any. |
icon | any | Yes | The emoji icon, if configured. |
scope | "personal" | "team" | "org" | Yes | The visibility scope. |
agentType | "agent" | "llm_proxy" | "mcp_gateway" | "profile" | Yes | The resource type. |
systemPrompt | any | No | |
teams | object[] | Yes | The teams attached to it. |
teams[].id | string | Yes | The team ID. |
teams[].name | string | Yes | The team name. |
labels | object[] | Yes | Assigned labels. |
labels[].key | string | Yes | The label key. |
labels[].value | string | Yes | The label value. |
tools | object[] | Yes | Assigned tools. |
tools[].id | string | Yes | The assigned tool ID. |
tools[].name | string | Yes | The tool name. |
tools[].description | any | Yes | The tool description, if any. |
tools[].catalogId | any | Yes | The MCP catalog ID the tool comes from, if any. |
knowledgeBaseIds | string[] | Yes | Assigned knowledge base IDs. |
connectorIds | string[] | Yes | Assigned knowledge connector IDs. |
suggestedPrompts | object[] | Yes | Configured suggested prompts. |
suggestedPrompts[].summaryTitle | string | Yes | The short title shown in the chat UI. |
suggestedPrompts[].prompt | string | Yes | The suggested prompt text. |
edit_mcp_gateway
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the MCP gateway to edit. Use get_mcp_gateway to look it up by name first if needed. |
description | any | No | New description for the MCP gateway. |
icon | any | No | New emoji icon for the MCP gateway. |
labels | object[] | No | Replace the MCP gateway's labels with this set. |
labels[].key | string | Yes | |
labels[].value | string | Yes | |
name | string | No | New name for the MCP gateway. |
scope | "personal" | "team" | "org" | No | Updated visibility scope for the MCP gateway. |
teams | string[] | No | Replace the teams attached to a team-scoped MCP gateway. |
knowledgeBaseIds | string[] | No | Replace the MCP gateway's assigned knowledge bases with this set. |
connectorIds | string[] | No | Replace the MCP gateway's directly assigned knowledge connectors with this set. |
MCP Servers
| Tool | Description |
|---|---|
search_private_mcp_registry | Search the private MCP registry for available MCP servers. |
get_mcp_servers | List all MCP servers from the catalog. |
get_mcp_server_tools | Get all tools available for a specific MCP server by its catalog ID (from get_mcp_servers). |
edit_mcp_description | Edit an MCP server's display information and metadata. |
edit_mcp_config | Edit an MCP server's technical configuration. |
create_mcp_server | Create a new MCP server in the private registry. |
deploy_mcp_server | Deploy (install) an MCP server from the catalog. |
list_mcp_server_deployments | List all deployed (installed) MCP server instances accessible to the current user. |
get_mcp_server_logs | Get recent container logs from a deployed local (K8s) MCP server. |
create_mcp_server_installation_request | Allows users from within the Archestra Platform chat UI to submit a request for an MCP server to be added to their Archestra Platform's internal MCP server registry. |
search_private_mcp_registry
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | No | Optional search query to filter MCP servers by name or description. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
items | object[] | Yes | Catalog items matching the search. |
items[].id | string | Yes | The catalog item ID. |
items[].name | string | Yes | The MCP server name. |
items[].version | any | Yes | The version, if provided. |
items[].description | any | Yes | The server description, if any. |
items[].serverType | "local" | "remote" | "builtin" | Yes | Whether the server is local, remote, or builtin. |
items[].serverUrl | any | Yes | The remote server URL, if applicable. |
items[].repository | any | Yes | The repository URL, if available. |
get_mcp_servers
This tool takes no arguments.
Output
| Field | Type | Required | Description |
|---|---|---|---|
items | object[] | Yes | Available MCP servers. |
items[].id | string | Yes | The catalog item ID. |
items[].name | string | Yes | The MCP server name. |
items[].icon | any | Yes | The emoji icon, if any. |
items[].description | any | Yes | The server description, if any. |
items[].scope | "personal" | "team" | "org" | No | The visibility scope of the server. |
items[].teams | object[] | Yes | Teams attached to a team-scoped server. |
items[].teams[].id | string | Yes | The team ID. |
items[].teams[].name | string | Yes | The team name. |
get_mcp_server_tools
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
mcpServerId | string | Yes | The catalog ID of the MCP server. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
tools | object[] | Yes | Tools exposed by the selected MCP server. |
tools[].id | string | Yes | The tool ID. |
tools[].name | string | Yes | The tool name. |
tools[].description | any | No | The tool description, if any. |
tools[].catalogId | any | No | The MCP catalog ID this tool belongs to. |
edit_mcp_description
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The catalog ID of the MCP server to edit. Use get_mcp_servers to look it up by name. |
name | string | No | Display name for the MCP server. |
description | any | No | Description of the MCP server. |
icon | any | No | Emoji icon for the MCP server. |
docsUrl | any | No | Documentation URL. |
repository | any | No | Source code repository URL. |
version | any | No | Version string. |
instructions | any | No | Setup or usage instructions. |
scope | "personal" | "team" | "org" | No | Visibility scope. |
labels | object[] | No | Key-value labels for organization/categorization. |
labels[].key | string | Yes | Label key. |
labels[].value | string | Yes | Label value. |
teams | string[] | No | Team IDs for team-scoped access control. |
edit_mcp_config
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The catalog ID of the MCP server to edit. Use get_mcp_servers to look it up by name. |
serverType | "local" | "remote" | "builtin" | No | Server type: local, remote, or builtin. |
serverUrl | any | No | [Remote] The URL of the remote MCP server. |
requiresAuth | boolean | No | [Remote] Whether the server requires authentication. |
authDescription | any | No | [Remote] How to set up authentication. |
authFields | object[] | No | [Remote] Authentication field definitions. |
authFields[].name | string | Yes | Auth field name. |
authFields[].label | string | Yes | Human-readable auth field label. |
authFields[].type | "header" | "query" | "cookie" | Yes | Where to send this auth field. |
authFields[].secret | boolean | Yes | Whether this field contains secret data. |
oauthConfig | object | No | [Remote] OAuth configuration for the server. |
command | string | No | [Local] Command to run (for example npx, uvx, or node). |
arguments | string[] | No | [Local] Command-line arguments. |
environment | object[] | No | [Local] Environment variables for the server process. |
environment[].key | string | Yes | Environment variable name. |
environment[].type | "plain_text" | "secret" | "boolean" | "number" | Yes | Environment variable value type. |
environment[].value | string | No | Literal environment variable value. |
environment[].promptOnInstallation | boolean | Yes | Whether to prompt for this value during installation. |
environment[].required | boolean | No | Whether the value is required. |
environment[].description | string | No | Description shown to users. |
environment[].default | any | No | Default value. |
environment[].mounted | boolean | No | For secret values, mount as a file instead of an env var. |
envFrom | object[] | No | [Local] Import env vars from Kubernetes Secrets or ConfigMaps. |
envFrom[].type | "secret" | "configMap" | Yes | Import source type. |
envFrom[].name | string | Yes | Secret or ConfigMap name. |
envFrom[].prefix | string | No | Optional environment variable prefix. |
dockerImage | string | No | [Local] Custom Docker image. |
serviceAccount | string | No | [Local] Kubernetes ServiceAccount name. |
transportType | "stdio" | "streamable-http" | No | [Local] Transport type. |
httpPort | number | No | [Local] HTTP port for streamable-http transport. |
httpPath | string | No | [Local] HTTP path for streamable-http transport. |
nodePort | number | No | [Local] Kubernetes NodePort for local development. |
imagePullSecrets | object[] | No | [Local] Image pull secrets for private registries. |
imagePullSecrets[].source | "existing" | Yes | Image pull secret source. |
imagePullSecrets[].name | string | Yes | Existing Kubernetes secret name. |
deploymentSpecYaml | string | No | [Local] Custom Kubernetes deployment YAML override. |
installationCommand | string | No | [Local] Command to install the MCP server package. |
userConfig | object | No | User-configurable fields shown during installation. |
create_mcp_server
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Display name for the MCP server. |
description | any | No | Description of the MCP server. |
icon | any | No | Emoji icon for the MCP server. |
docsUrl | any | No | Documentation URL. |
repository | any | No | Source code repository URL. |
version | any | No | Version string. |
instructions | any | No | Setup or usage instructions. |
scope | "personal" | "team" | "org" | No | Visibility scope. |
labels | object[] | No | Key-value labels for organization/categorization. |
labels[].key | string | Yes | Label key. |
labels[].value | string | Yes | Label value. |
teams | string[] | No | Team IDs for team-scoped access control. |
serverType | "local" | "remote" | "builtin" | No | Server type: local, remote, or builtin. |
serverUrl | any | No | [Remote] The URL of the remote MCP server. |
requiresAuth | boolean | No | [Remote] Whether the server requires authentication. |
authDescription | any | No | [Remote] How to set up authentication. |
authFields | object[] | No | [Remote] Authentication field definitions. |
authFields[].name | string | Yes | Auth field name. |
authFields[].label | string | Yes | Human-readable auth field label. |
authFields[].type | "header" | "query" | "cookie" | Yes | Where to send this auth field. |
authFields[].secret | boolean | Yes | Whether this field contains secret data. |
oauthConfig | object | No | [Remote] OAuth configuration for the server. |
command | string | No | [Local] Command to run (for example npx, uvx, or node). |
arguments | string[] | No | [Local] Command-line arguments. |
environment | object[] | No | [Local] Environment variables for the server process. |
environment[].key | string | Yes | Environment variable name. |
environment[].type | "plain_text" | "secret" | "boolean" | "number" | Yes | Environment variable value type. |
environment[].value | string | No | Literal environment variable value. |
environment[].promptOnInstallation | boolean | Yes | Whether to prompt for this value during installation. |
environment[].required | boolean | No | Whether the value is required. |
environment[].description | string | No | Description shown to users. |
environment[].default | any | No | Default value. |
environment[].mounted | boolean | No | For secret values, mount as a file instead of an env var. |
envFrom | object[] | No | [Local] Import env vars from Kubernetes Secrets or ConfigMaps. |
envFrom[].type | "secret" | "configMap" | Yes | Import source type. |
envFrom[].name | string | Yes | Secret or ConfigMap name. |
envFrom[].prefix | string | No | Optional environment variable prefix. |
dockerImage | string | No | [Local] Custom Docker image. |
serviceAccount | string | No | [Local] Kubernetes ServiceAccount name. |
transportType | "stdio" | "streamable-http" | No | [Local] Transport type. |
httpPort | number | No | [Local] HTTP port for streamable-http transport. |
httpPath | string | No | [Local] HTTP path for streamable-http transport. |
nodePort | number | No | [Local] Kubernetes NodePort for local development. |
imagePullSecrets | object[] | No | [Local] Image pull secrets for private registries. |
imagePullSecrets[].source | "existing" | Yes | Image pull secret source. |
imagePullSecrets[].name | string | Yes | Existing Kubernetes secret name. |
deploymentSpecYaml | string | No | [Local] Custom Kubernetes deployment YAML override. |
installationCommand | string | No | [Local] Command to install the MCP server package. |
userConfig | object | No | User-configurable fields shown during installation. |
deploy_mcp_server
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
catalogId | string | Yes | The catalog ID of the MCP server to deploy. |
teamId | string | No | Optional team ID for a team-scoped deployment. |
agentIds | string[] | No | Optional agent IDs to assign the server's tools to after deployment. |
list_mcp_server_deployments
This tool takes no arguments.
get_mcp_server_logs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
serverId | string | Yes | The deployment ID of the MCP server. |
lines | integer | No | Number of log lines to retrieve. |
create_mcp_server_installation_request
This tool takes no arguments.
Limits
| Tool | Description |
|---|---|
create_limit | Create a new cost or usage limit for an organization, team, agent, LLM proxy, or MCP gateway. |
get_limits | Retrieve all limits, optionally filtered by entity type and/or entity ID. |
update_limit | Update mutable fields on an existing limit. |
delete_limit | Delete an existing limit by ID. |
get_agent_token_usage | Get the total token usage (input and output) for a specific agent. |
get_llm_proxy_token_usage | Get the total token usage (input and output) for a specific LLM proxy. |
create_limit
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type | "organization" | "team" | "agent" | Yes | The type of entity to apply the limit to. |
entity_id | string | Yes | The ID of the entity (organization, team, or agent). |
limit_type | "token_cost" | "mcp_server_calls" | "tool_calls" | Yes | The type of limit to apply. |
limit_value | number | Yes | The limit value (tokens or count depending on limit type). |
model | string[] | No | Array of model names. Required for token_cost limits. |
mcp_server_name | string | No | MCP server name. Required for mcp_server_calls and tool_calls limits. |
tool_name | string | No | Tool name. Required for tool_calls limits. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
limit | object | Yes | |
limit.id | string | Yes | The limit ID. |
limit.entityType | "organization" | "team" | "agent" | Yes | The limited entity type. |
limit.entityId | string | Yes | The limited entity ID. |
limit.limitType | "token_cost" | "mcp_server_calls" | "tool_calls" | Yes | The kind of limit. |
limit.limitValue | number | Yes | The configured limit value. |
limit.model | any | No | Models targeted by a token_cost limit, if any. |
limit.mcpServerName | any | No | MCP server name for MCP-specific limits, if any. |
limit.toolName | any | No | Tool name for tool-specific limits, if any. |
get_limits
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
entity_type | "organization" | "team" | "agent" | No | Optional filter by entity type. |
entity_id | string | No | Optional filter by entity ID. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
limits | object[] | Yes | |
limits[].id | string | Yes | The limit ID. |
limits[].entityType | "organization" | "team" | "agent" | Yes | The limited entity type. |
limits[].entityId | string | Yes | The limited entity ID. |
limits[].limitType | "token_cost" | "mcp_server_calls" | "tool_calls" | Yes | The kind of limit. |
limits[].limitValue | number | Yes | The configured limit value. |
limits[].model | any | No | Models targeted by a token_cost limit, if any. |
limits[].mcpServerName | any | No | MCP server name for MCP-specific limits, if any. |
limits[].toolName | any | No | Tool name for tool-specific limits, if any. |
update_limit
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the limit to update. |
limit_value | number | No | Optional new limit value. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
limit | object | Yes | |
limit.id | string | Yes | The limit ID. |
limit.entityType | "organization" | "team" | "agent" | Yes | The limited entity type. |
limit.entityId | string | Yes | The limited entity ID. |
limit.limitType | "token_cost" | "mcp_server_calls" | "tool_calls" | Yes | The kind of limit. |
limit.limitValue | number | Yes | The configured limit value. |
limit.model | any | No | Models targeted by a token_cost limit, if any. |
limit.mcpServerName | any | No | MCP server name for MCP-specific limits, if any. |
limit.toolName | any | No | Tool name for tool-specific limits, if any. |
delete_limit
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the limit to delete. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | |
id | string | Yes |
get_agent_token_usage
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | No | Optional agent ID. Defaults to the current agent. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
totalInputTokens | number | Yes | |
totalOutputTokens | number | Yes | |
totalTokens | number | Yes |
get_llm_proxy_token_usage
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | No | Optional LLM proxy ID. Defaults to the current agent. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
totalInputTokens | number | Yes | |
totalOutputTokens | number | Yes | |
totalTokens | number | Yes |
Policies
| Tool | Description |
|---|---|
get_autonomy_policy_operators | Get all supported policy operators with their human-readable labels |
get_tool_invocation_policies | Get all tool invocation policies |
create_tool_invocation_policy | Create a new tool invocation policy |
get_tool_invocation_policy | Get a specific tool invocation policy by ID |
update_tool_invocation_policy | Update a tool invocation policy |
delete_tool_invocation_policy | Delete a tool invocation policy by ID |
get_trusted_data_policies | Get all trusted data policies |
create_trusted_data_policy | Create a new trusted data policy |
get_trusted_data_policy | Get a specific trusted data policy by ID |
update_trusted_data_policy | Update a trusted data policy |
delete_trusted_data_policy | Delete a trusted data policy by ID |
get_autonomy_policy_operators
This tool takes no arguments.
Output
| Field | Type | Required | Description |
|---|---|---|---|
operators | object[] | Yes | Supported autonomy policy operators. |
operators[].value | "equal" | "notEqual" | "contains" | "notContains" | "startsWith" | "endsWith" | "regex" | Yes | The operator enum value. |
operators[].label | string | Yes | The human-readable label. |
get_tool_invocation_policies
This tool takes no arguments.
Output
| Field | Type | Required | Description |
|---|---|---|---|
policies | object[] | Yes | Tool invocation policies. |
policies[].id | string | Yes | The policy ID. |
policies[].toolId | string | Yes | The tool ID this policy targets. |
policies[].conditions | object[] | Yes | Conditions evaluated for the policy. |
policies[].conditions[].key | string | Yes | The evaluated argument or context key. |
policies[].conditions[].operator | "equal" | "notEqual" | "contains" | "notContains" | "startsWith" | "endsWith" | "regex" | Yes | The comparison operator. |
policies[].conditions[].value | string | Yes | The comparison value. |
policies[].action | "allow_when_context_is_untrusted" | "block_when_context_is_untrusted" | "block_always" | "require_approval" | Yes | The policy action. |
policies[].reason | any | Yes | The policy reason, if any. |
create_tool_invocation_policy
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
toolId | string | Yes | The ID of the tool (UUID from the tools table). |
conditions | object[] | Yes | Array of conditions that must all match. Empty array means unconditional. |
conditions[].key | string | Yes | The argument name or context path to evaluate (for example url or context.externalAgentId). |
conditions[].operator | "equal" | "notEqual" | "contains" | "notContains" | "startsWith" | "endsWith" | "regex" | Yes | The comparison operator. |
conditions[].value | string | Yes | The value to compare against. |
action | "allow_when_context_is_untrusted" | "block_when_context_is_untrusted" | "block_always" | "require_approval" | Yes | The action to take when the policy matches. |
reason | string | No | Human-readable explanation for why this policy exists. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
policy | object | Yes | The requested tool invocation policy. |
policy.id | string | Yes | The policy ID. |
policy.toolId | string | Yes | The tool ID this policy targets. |
policy.conditions | object[] | Yes | Conditions evaluated for the policy. |
policy.conditions[].key | string | Yes | The evaluated argument or context key. |
policy.conditions[].operator | "equal" | "notEqual" | "contains" | "notContains" | "startsWith" | "endsWith" | "regex" | Yes | The comparison operator. |
policy.conditions[].value | string | Yes | The comparison value. |
policy.action | "allow_when_context_is_untrusted" | "block_when_context_is_untrusted" | "block_always" | "require_approval" | Yes | The policy action. |
policy.reason | any | Yes | The policy reason, if any. |
get_tool_invocation_policy
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the tool invocation policy. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
policy | object | Yes | The requested tool invocation policy. |
policy.id | string | Yes | The policy ID. |
policy.toolId | string | Yes | The tool ID this policy targets. |
policy.conditions | object[] | Yes | Conditions evaluated for the policy. |
policy.conditions[].key | string | Yes | The evaluated argument or context key. |
policy.conditions[].operator | "equal" | "notEqual" | "contains" | "notContains" | "startsWith" | "endsWith" | "regex" | Yes | The comparison operator. |
policy.conditions[].value | string | Yes | The comparison value. |
policy.action | "allow_when_context_is_untrusted" | "block_when_context_is_untrusted" | "block_always" | "require_approval" | Yes | The policy action. |
policy.reason | any | Yes | The policy reason, if any. |
update_tool_invocation_policy
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the tool invocation policy to update. |
toolId | string | No | The ID of the tool (UUID from the tools table). |
conditions | object[] | No | Updated array of conditions that must all match. Empty array means unconditional. |
conditions[].key | string | Yes | The argument name or context path to evaluate (for example url or context.externalAgentId). |
conditions[].operator | "equal" | "notEqual" | "contains" | "notContains" | "startsWith" | "endsWith" | "regex" | Yes | The comparison operator. |
conditions[].value | string | Yes | The value to compare against. |
action | "allow_when_context_is_untrusted" | "block_when_context_is_untrusted" | "block_always" | "require_approval" | No | Updated action to take when the policy matches. |
reason | any | No | Updated human-readable explanation for why this policy exists. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
policy | object | Yes | The requested tool invocation policy. |
policy.id | string | Yes | The policy ID. |
policy.toolId | string | Yes | The tool ID this policy targets. |
policy.conditions | object[] | Yes | Conditions evaluated for the policy. |
policy.conditions[].key | string | Yes | The evaluated argument or context key. |
policy.conditions[].operator | "equal" | "notEqual" | "contains" | "notContains" | "startsWith" | "endsWith" | "regex" | Yes | The comparison operator. |
policy.conditions[].value | string | Yes | The comparison value. |
policy.action | "allow_when_context_is_untrusted" | "block_when_context_is_untrusted" | "block_always" | "require_approval" | Yes | The policy action. |
policy.reason | any | Yes | The policy reason, if any. |
delete_tool_invocation_policy
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the tool invocation policy. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | Whether the delete succeeded. |
get_trusted_data_policies
This tool takes no arguments.
Output
| Field | Type | Required | Description |
|---|---|---|---|
policies | object[] | Yes | Trusted data policies. |
policies[].id | string | Yes | The policy ID. |
policies[].toolId | string | Yes | The tool ID this policy targets. |
policies[].conditions | object[] | Yes | Conditions evaluated for the policy. |
policies[].conditions[].key | string | Yes | The evaluated result key or path. |
policies[].conditions[].operator | "equal" | "notEqual" | "contains" | "notContains" | "startsWith" | "endsWith" | "regex" | Yes | The comparison operator. |
policies[].conditions[].value | string | Yes | The comparison value. |
policies[].action | "block_always" | "mark_as_trusted" | "mark_as_untrusted" | "sanitize_with_dual_llm" | Yes | The policy action. |
policies[].description | any | Yes | The policy description, if any. |
create_trusted_data_policy
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
toolId | string | Yes | The ID of the tool (UUID from the tools table). |
conditions | object[] | Yes | Array of conditions that must all match. Empty array means unconditional. |
conditions[].key | string | Yes | The attribute key or path in the tool result to evaluate (for example emails[*].from or source). |
conditions[].operator | "equal" | "notEqual" | "contains" | "notContains" | "startsWith" | "endsWith" | "regex" | Yes | The comparison operator. |
conditions[].value | string | Yes | The value to compare against. |
action | "block_always" | "mark_as_trusted" | "mark_as_untrusted" | "sanitize_with_dual_llm" | Yes | The action to take when the policy matches. |
description | string | No | Human-readable explanation for why this policy exists. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
policy | object | Yes | The requested trusted data policy. |
policy.id | string | Yes | The policy ID. |
policy.toolId | string | Yes | The tool ID this policy targets. |
policy.conditions | object[] | Yes | Conditions evaluated for the policy. |
policy.conditions[].key | string | Yes | The evaluated result key or path. |
policy.conditions[].operator | "equal" | "notEqual" | "contains" | "notContains" | "startsWith" | "endsWith" | "regex" | Yes | The comparison operator. |
policy.conditions[].value | string | Yes | The comparison value. |
policy.action | "block_always" | "mark_as_trusted" | "mark_as_untrusted" | "sanitize_with_dual_llm" | Yes | The policy action. |
policy.description | any | Yes | The policy description, if any. |
get_trusted_data_policy
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the trusted data policy. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
policy | object | Yes | The requested trusted data policy. |
policy.id | string | Yes | The policy ID. |
policy.toolId | string | Yes | The tool ID this policy targets. |
policy.conditions | object[] | Yes | Conditions evaluated for the policy. |
policy.conditions[].key | string | Yes | The evaluated result key or path. |
policy.conditions[].operator | "equal" | "notEqual" | "contains" | "notContains" | "startsWith" | "endsWith" | "regex" | Yes | The comparison operator. |
policy.conditions[].value | string | Yes | The comparison value. |
policy.action | "block_always" | "mark_as_trusted" | "mark_as_untrusted" | "sanitize_with_dual_llm" | Yes | The policy action. |
policy.description | any | Yes | The policy description, if any. |
update_trusted_data_policy
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the trusted data policy to update. |
toolId | string | No | The ID of the tool (UUID from the tools table). |
conditions | object[] | No | Updated array of conditions that must all match. Empty array means unconditional. |
conditions[].key | string | Yes | The attribute key or path in the tool result to evaluate (for example emails[*].from or source). |
conditions[].operator | "equal" | "notEqual" | "contains" | "notContains" | "startsWith" | "endsWith" | "regex" | Yes | The comparison operator. |
conditions[].value | string | Yes | The value to compare against. |
action | "block_always" | "mark_as_trusted" | "mark_as_untrusted" | "sanitize_with_dual_llm" | No | Updated action to take when the policy matches. |
description | any | No | Updated human-readable explanation for why this policy exists. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
policy | object | Yes | The requested trusted data policy. |
policy.id | string | Yes | The policy ID. |
policy.toolId | string | Yes | The tool ID this policy targets. |
policy.conditions | object[] | Yes | Conditions evaluated for the policy. |
policy.conditions[].key | string | Yes | The evaluated result key or path. |
policy.conditions[].operator | "equal" | "notEqual" | "contains" | "notContains" | "startsWith" | "endsWith" | "regex" | Yes | The comparison operator. |
policy.conditions[].value | string | Yes | The comparison value. |
policy.action | "block_always" | "mark_as_trusted" | "mark_as_untrusted" | "sanitize_with_dual_llm" | Yes | The policy action. |
policy.description | any | Yes | The policy description, if any. |
delete_trusted_data_policy
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the trusted data policy. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | Whether the delete succeeded. |
Tool Assignment
| Tool | Description |
|---|---|
bulk_assign_tools_to_agents | Assign multiple tools to multiple agents in bulk with validation and error handling |
bulk_assign_tools_to_mcp_gateways | Assign multiple tools to multiple MCP gateways in bulk with validation and error handling |
bulk_assign_tools_to_agents
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
assignments | object[] | Yes | Assignments to create or update for agents. |
assignments[].toolId | string | Yes | The ID of the tool to assign. |
assignments[].credentialSourceMcpServerId | any | No | For remote MCP tools, the deployed MCP server ID that should provide credentials. |
assignments[].executionSourceMcpServerId | any | No | For local MCP tools, the deployed MCP server ID that should execute the tool. |
assignments[].useDynamicTeamCredential | boolean | No | When true, resolve credentials dynamically from the invoking team instead of pinning a deployment. |
assignments[].agentId | string | Yes | The agent ID to assign the tool to. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
succeeded | object[] | Yes | Assignments that succeeded. |
succeeded[].agentId | string | Yes | The target agent ID. |
succeeded[].toolId | string | Yes | The tool ID. |
succeeded[].error | string | No | Validation or assignment error. |
failed | object[] | Yes | Assignments that failed. |
failed[].agentId | string | Yes | The target agent ID. |
failed[].toolId | string | Yes | The tool ID. |
failed[].error | string | No | Validation or assignment error. |
duplicates | object[] | Yes | Assignments skipped because they already existed. |
duplicates[].agentId | string | Yes | The target agent ID. |
duplicates[].toolId | string | Yes | The tool ID. |
duplicates[].error | string | No | Validation or assignment error. |
bulk_assign_tools_to_mcp_gateways
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
assignments | object[] | Yes | Assignments to create or update for MCP gateways. |
assignments[].toolId | string | Yes | The ID of the tool to assign. |
assignments[].credentialSourceMcpServerId | any | No | For remote MCP tools, the deployed MCP server ID that should provide credentials. |
assignments[].executionSourceMcpServerId | any | No | For local MCP tools, the deployed MCP server ID that should execute the tool. |
assignments[].useDynamicTeamCredential | boolean | No | When true, resolve credentials dynamically from the invoking team instead of pinning a deployment. |
assignments[].mcpGatewayId | string | Yes | The MCP gateway ID to assign the tool to. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
succeeded | object[] | Yes | Assignments that succeeded. |
succeeded[].mcpGatewayId | string | Yes | The target MCP gateway ID. |
succeeded[].toolId | string | Yes | The tool ID. |
succeeded[].error | string | No | Validation or assignment error. |
failed | object[] | Yes | Assignments that failed. |
failed[].mcpGatewayId | string | Yes | The target MCP gateway ID. |
failed[].toolId | string | Yes | The tool ID. |
failed[].error | string | No | Validation or assignment error. |
duplicates | object[] | Yes | Assignments skipped because they already existed. |
duplicates[].mcpGatewayId | string | Yes | The target MCP gateway ID. |
duplicates[].toolId | string | Yes | The tool ID. |
duplicates[].error | string | No | Validation or assignment error. |
Knowledge Management
| Tool | Description |
|---|---|
query_knowledge_sources | Query the organization's knowledge sources to retrieve relevant information. |
create_knowledge_base | Create a new knowledge base for organizing knowledge connectors. |
get_knowledge_bases | List all knowledge bases in the organization. |
get_knowledge_base | Get details of a specific knowledge base by ID. |
update_knowledge_base | Update an existing knowledge base. |
delete_knowledge_base | Delete a knowledge base by ID. |
create_knowledge_connector | Create a new knowledge connector for ingesting data from external sources. |
get_knowledge_connectors | List all knowledge connectors in the organization. |
get_knowledge_connector | Get details of a specific knowledge connector by ID. |
update_knowledge_connector | Update an existing knowledge connector. |
delete_knowledge_connector | Delete a knowledge connector by ID. |
assign_knowledge_connector_to_knowledge_base | Assign a knowledge connector to a knowledge base. |
unassign_knowledge_connector_from_knowledge_base | Remove a knowledge connector from a knowledge base. |
assign_knowledge_base_to_agent | Assign a knowledge base to an agent. |
unassign_knowledge_base_from_agent | Remove a knowledge base from an agent. |
assign_knowledge_connector_to_agent | Directly assign a knowledge connector to an agent (bypassing knowledge base). |
unassign_knowledge_connector_from_agent | Remove a directly-assigned knowledge connector from an agent. |
query_knowledge_sources
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | Yes | The user's original query, passed verbatim without rephrasing or expansion. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
results | any[] | Yes | Retrieved knowledge results. |
totalChunks | number | Yes | The number of result chunks returned. |
create_knowledge_base
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the knowledge base. |
description | any | No | Description of the knowledge base. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
knowledgeBase | object | Yes | The requested knowledge base. |
knowledgeBase.id | string | Yes | The knowledge base ID. |
knowledgeBase.organizationId | string | Yes | The organization ID. |
knowledgeBase.name | string | Yes | The knowledge base name. |
knowledgeBase.description | any | Yes | The knowledge base description, if any. |
knowledgeBase.status | string | Yes | The knowledge base status. |
knowledgeBase.visibility | string | Yes | The knowledge base visibility. |
knowledgeBase.teamIds | string[] | Yes | Team IDs with access. |
get_knowledge_bases
This tool takes no arguments.
Output
| Field | Type | Required | Description |
|---|---|---|---|
knowledgeBases | object[] | Yes | Knowledge bases in the organization. |
knowledgeBases[].id | string | Yes | The knowledge base ID. |
knowledgeBases[].organizationId | string | Yes | The organization ID. |
knowledgeBases[].name | string | Yes | The knowledge base name. |
knowledgeBases[].description | any | Yes | The knowledge base description, if any. |
knowledgeBases[].status | string | Yes | The knowledge base status. |
knowledgeBases[].visibility | string | Yes | The knowledge base visibility. |
knowledgeBases[].teamIds | string[] | Yes | Team IDs with access. |
get_knowledge_base
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Knowledge base ID. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
knowledgeBase | object | Yes | The requested knowledge base. |
knowledgeBase.id | string | Yes | The knowledge base ID. |
knowledgeBase.organizationId | string | Yes | The organization ID. |
knowledgeBase.name | string | Yes | The knowledge base name. |
knowledgeBase.description | any | Yes | The knowledge base description, if any. |
knowledgeBase.status | string | Yes | The knowledge base status. |
knowledgeBase.visibility | string | Yes | The knowledge base visibility. |
knowledgeBase.teamIds | string[] | Yes | Team IDs with access. |
update_knowledge_base
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Knowledge base ID. |
name | string | No | New knowledge base name. |
description | any | No | New knowledge base description. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
knowledgeBase | object | Yes | The requested knowledge base. |
knowledgeBase.id | string | Yes | The knowledge base ID. |
knowledgeBase.organizationId | string | Yes | The organization ID. |
knowledgeBase.name | string | Yes | The knowledge base name. |
knowledgeBase.description | any | Yes | The knowledge base description, if any. |
knowledgeBase.status | string | Yes | The knowledge base status. |
knowledgeBase.visibility | string | Yes | The knowledge base visibility. |
knowledgeBase.teamIds | string[] | Yes | Team IDs with access. |
delete_knowledge_base
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Knowledge base ID. |
create_knowledge_connector
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the knowledge connector. |
connector_type | string | Yes | Type of the knowledge connector (for example jira, confluence, or google_drive). |
config | object | Yes | Provider-specific configuration object. |
description | any | No | Description of the knowledge connector. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
knowledgeConnector | object | Yes | The requested knowledge connector. |
knowledgeConnector.id | string | Yes | The knowledge connector ID. |
knowledgeConnector.organizationId | string | Yes | The organization ID. |
knowledgeConnector.knowledgeBaseId | any | No | |
knowledgeConnector.name | string | Yes | The connector name. |
knowledgeConnector.connectorType | string | Yes | The connector type. |
knowledgeConnector.description | any | Yes | The connector description, if any. |
knowledgeConnector.enabled | boolean | No | |
knowledgeConnector.config | any | Yes | The provider-specific connector configuration. |
get_knowledge_connectors
This tool takes no arguments.
Output
| Field | Type | Required | Description |
|---|---|---|---|
knowledgeConnectors | object[] | Yes | Knowledge connectors in the organization. |
knowledgeConnectors[].id | string | Yes | The knowledge connector ID. |
knowledgeConnectors[].organizationId | string | Yes | The organization ID. |
knowledgeConnectors[].knowledgeBaseId | any | No | |
knowledgeConnectors[].name | string | Yes | The connector name. |
knowledgeConnectors[].connectorType | string | Yes | The connector type. |
knowledgeConnectors[].description | any | Yes | The connector description, if any. |
knowledgeConnectors[].enabled | boolean | No | |
knowledgeConnectors[].config | any | Yes | The provider-specific connector configuration. |
get_knowledge_connector
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Knowledge connector ID. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
knowledgeConnector | object | Yes | The requested knowledge connector. |
knowledgeConnector.id | string | Yes | The knowledge connector ID. |
knowledgeConnector.organizationId | string | Yes | The organization ID. |
knowledgeConnector.knowledgeBaseId | any | No | |
knowledgeConnector.name | string | Yes | The connector name. |
knowledgeConnector.connectorType | string | Yes | The connector type. |
knowledgeConnector.description | any | Yes | The connector description, if any. |
knowledgeConnector.enabled | boolean | No | |
knowledgeConnector.config | any | Yes | The provider-specific connector configuration. |
update_knowledge_connector
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Knowledge connector ID. |
name | string | No | New connector name. |
description | any | No | New connector description. |
enabled | boolean | No | Whether the connector is enabled. |
config | object | No | Updated connector configuration (provider-specific settings). |
Output
| Field | Type | Required | Description |
|---|---|---|---|
knowledgeConnector | object | Yes | The requested knowledge connector. |
knowledgeConnector.id | string | Yes | The knowledge connector ID. |
knowledgeConnector.organizationId | string | Yes | The organization ID. |
knowledgeConnector.knowledgeBaseId | any | No | |
knowledgeConnector.name | string | Yes | The connector name. |
knowledgeConnector.connectorType | string | Yes | The connector type. |
knowledgeConnector.description | any | Yes | The connector description, if any. |
knowledgeConnector.enabled | boolean | No | |
knowledgeConnector.config | any | Yes | The provider-specific connector configuration. |
delete_knowledge_connector
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Knowledge connector ID. |
assign_knowledge_connector_to_knowledge_base
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
connector_id | string | Yes | Knowledge connector ID. |
knowledge_base_id | string | Yes | Knowledge base ID. |
unassign_knowledge_connector_from_knowledge_base
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
connector_id | string | Yes | Knowledge connector ID. |
knowledge_base_id | string | Yes | Knowledge base ID. |
assign_knowledge_base_to_agent
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
knowledge_base_id | string | Yes | Knowledge base ID. |
agent_id | string | Yes | Agent ID. |
unassign_knowledge_base_from_agent
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
knowledge_base_id | string | Yes | Knowledge base ID. |
agent_id | string | Yes | Agent ID. |
assign_knowledge_connector_to_agent
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
connector_id | string | Yes | Knowledge connector ID. |
agent_id | string | Yes | Agent ID. |
unassign_knowledge_connector_from_agent
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
connector_id | string | Yes | Knowledge connector ID. |
agent_id | string | Yes | Agent ID. |
Chat
| Tool | Description |
|---|---|
todo_write | Write todos to the current conversation. |
swap_agent | Switch the current conversation to a different agent. |
swap_to_default_agent | Return to the default agent. |
artifact_write | Write or update a markdown artifact for the current conversation. |
todo_write
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
todos | object[] | Yes | Array of todo items to write to the conversation. |
todos[].id | integer | Yes | Unique identifier for the todo item. |
todos[].content | string | Yes | The content or description of the todo item. |
todos[].status | "pending" | "in_progress" | "completed" | Yes | The current status of the todo item. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | Whether the write succeeded. |
todoCount | integer | Yes | How many todo items were written. |
swap_agent
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
agent_name | string | Yes | The name of the agent to switch to. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | Whether the swap succeeded. |
agent_id | string | Yes | The agent ID the conversation now uses. |
agent_name | string | Yes | The agent name the conversation now uses. |
swap_to_default_agent
This tool takes no arguments.
Output
| Field | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | Whether the swap succeeded. |
agent_id | string | Yes | The agent ID the conversation now uses. |
agent_name | string | Yes | The agent name the conversation now uses. |
artifact_write
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
content | string | Yes | The markdown content to write to the conversation artifact. This completely replaces any existing artifact content. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | Whether the artifact write succeeded. |
characterCount | integer | Yes | The number of characters written to the artifact. |