Knowledge and MCP

Knowledge Management

ToolDescriptionPermission
query_knowledge_sourcesSearch the organization's indexed knowledge — documents, files, images, photos, and records synced from its connected sources.knowledgeSource:query
create_knowledge_baseCreate a new knowledge base for organizing knowledge connectors.knowledgeSource:create
get_knowledge_basesList all knowledge bases in the organization.knowledgeSource:read
get_knowledge_baseGet details of a specific knowledge base by ID.knowledgeSource:read
update_knowledge_baseUpdate an existing knowledge base.knowledgeSource:update
delete_knowledge_baseDelete a knowledge base by ID.knowledgeSource:delete
create_knowledge_connectorCreate a new knowledge connector for ingesting data from external sources.knowledgeSource:create
get_knowledge_connectorsList all knowledge connectors in the organization.knowledgeSource:read
get_knowledge_connectorGet details of a specific knowledge connector by ID.knowledgeSource:read
update_knowledge_connectorUpdate an existing knowledge connector.knowledgeSource:update
delete_knowledge_connectorDelete a knowledge connector by ID.knowledgeSource:delete
assign_knowledge_connector_to_knowledge_baseAssign a knowledge connector to a knowledge base.knowledgeSource:update
unassign_knowledge_connector_from_knowledge_baseRemove a knowledge connector from a knowledge base.knowledgeSource:update
assign_knowledge_base_to_agentAssign a knowledge base to an agent.knowledgeSource:update
unassign_knowledge_base_from_agentRemove a knowledge base from an agent.knowledgeSource:update
assign_knowledge_connector_to_agentDirectly assign a knowledge connector to an agent (bypassing knowledge base).knowledgeSource:update
unassign_knowledge_connector_from_agentRemove a directly-assigned knowledge connector from an agent.knowledgeSource:update

query_knowledge_sources

Required RBAC permission: knowledgeSource:query

Input

ParameterTypeRequiredDescription
querystringYesThe user's original query, passed verbatim without rephrasing or expansion.
documentFilterobjectNoOptional. Narrows the search to a subset of the indexed documents by their source metadata — for example {"spaceKey": "DEV"} or {"labels": ["release-2.0"]}. Keys are ANDed; a list of values for one key is ORed. Matches both single values and list-valued metadata. Only use this when the user's request explicitly names a subset to search; do NOT infer one from the topic of the question, and do NOT guess key or value names. If a filter matches nothing, the response lists the values that actually exist so the call can be retried with a real one.

Output

FieldTypeRequiredDescription
resultsany[]YesRetrieved knowledge results.
totalChunksnumberYesThe number of result chunks returned.
citationInstructionstringNoHow to cite these results: back each claim with a verbatim quote tagged with the source chunk's ref.
filterDiagnosticstringNoPresent only when documentFilter matched no documents. Names the values that do exist for the keys that were filtered on, so the search can be retried.

create_knowledge_base

Required RBAC permission: knowledgeSource:create

Input

ParameterTypeRequiredDescription
initialGrantsobject[]No
initialGrants[].subjectobjectYes
initialGrants[].subject.type"user" | "team" | "serviceAccount" | "role" | "organization"Yes
initialGrants[].subject.idstring | "*"Yes
initialGrants[].actionsstring[]Yes
namestringYesName of the knowledge base.
descriptionstring | nullNoDescription of the knowledge base.

Output

FieldTypeRequiredDescription
knowledgeBaseobjectYesThe requested knowledge base.
knowledgeBase.idstringYesThe knowledge base ID.
knowledgeBase.organizationIdstringYesThe organization ID.
knowledgeBase.namestringYesThe knowledge base name.
knowledgeBase.descriptionstring | nullYesThe knowledge base description, if any.
knowledgeBase.statusstringYesThe knowledge base status.

get_knowledge_bases

Required RBAC permission: knowledgeSource:read

Input

ParameterTypeRequiredDescription
accessstring[]NoOnly return items the caller reaches in one of these ways: mine (created by the caller), shared (shared with the caller or one of their teams), org (shared with the whole organization), others (not shared with the caller; visible only through admin access). Omit for everything the caller can read. Use ["mine"] for "my knowledge bases".
shared_withstring[]NoOnly return items whose own permissions grant read to one of these subjects: org (the whole organization), role:, team:, user:, serviceAccount:. Omit for no filtering.
owner_idsstring[]NoOnly return items created by one of these user IDs. Omit for no filtering.

Output

FieldTypeRequiredDescription
knowledgeBasesobject[]YesKnowledge bases in the organization.
knowledgeBases[].idstringYesThe knowledge base ID.
knowledgeBases[].organizationIdstringYesThe organization ID.
knowledgeBases[].namestringYesThe knowledge base name.
knowledgeBases[].descriptionstring | nullYesThe knowledge base description, if any.
knowledgeBases[].statusstringYesThe knowledge base status.

get_knowledge_base

Required RBAC permission: knowledgeSource:read

Input

ParameterTypeRequiredDescription
idstringYesKnowledge base ID.

Output

FieldTypeRequiredDescription
knowledgeBaseobjectYesThe requested knowledge base.
knowledgeBase.idstringYesThe knowledge base ID.
knowledgeBase.organizationIdstringYesThe organization ID.
knowledgeBase.namestringYesThe knowledge base name.
knowledgeBase.descriptionstring | nullYesThe knowledge base description, if any.
knowledgeBase.statusstringYesThe knowledge base status.

update_knowledge_base

Required RBAC permission: knowledgeSource:update

Input

ParameterTypeRequiredDescription
idstringYesKnowledge base ID.
uploadedFilesEnvironmentIdstring | nullNoEnvironment for this knowledge base's indexed uploaded files. Requires uploaded files to have been indexed; omit to leave it unchanged.
namestringNoNew knowledge base name.
descriptionstring | nullNoNew knowledge base description.

Output

FieldTypeRequiredDescription
knowledgeBaseobjectYesThe requested knowledge base.
knowledgeBase.idstringYesThe knowledge base ID.
knowledgeBase.organizationIdstringYesThe organization ID.
knowledgeBase.namestringYesThe knowledge base name.
knowledgeBase.descriptionstring | nullYesThe knowledge base description, if any.
knowledgeBase.statusstringYesThe knowledge base status.

delete_knowledge_base

Required RBAC permission: knowledgeSource:delete

Input

ParameterTypeRequiredDescription
idstringYesKnowledge base ID.

create_knowledge_connector

Required RBAC permission: knowledgeSource:create

Input

ParameterTypeRequiredDescription
initialGrantsobject[]No
initialGrants[].subjectobjectYes
initialGrants[].subject.type"user" | "team" | "serviceAccount" | "role" | "organization"Yes
initialGrants[].subject.idstring | "*"Yes
initialGrants[].actionsstring[]Yes
namestringYesName of the knowledge connector.
connector_typestringYesType of the knowledge connector (for example jira, confluence, or google_drive).
configobjectYesProvider-specific configuration object.
descriptionstring | nullNoDescription of the knowledge connector.
sync_permissions_from_sourcebooleanNoMirror each document's access control from the source, so a query only returns what the caller could open there. Requires an enterprise license and a connector type that supports it.

Output

FieldTypeRequiredDescription
knowledgeConnectorobjectYesThe requested knowledge connector.
knowledgeConnector.idstringYesThe knowledge connector ID.
knowledgeConnector.organizationIdstringYesThe organization ID.
knowledgeConnector.knowledgeBaseIdstring | nullNo
knowledgeConnector.namestringYesThe connector name.
knowledgeConnector.connectorTypestringYesThe connector type.
knowledgeConnector.descriptionstring | nullYesThe connector description, if any.
knowledgeConnector.enabledbooleanNo
knowledgeConnector.configanyYesThe provider-specific connector configuration.

get_knowledge_connectors

Required RBAC permission: knowledgeSource:read

This tool takes no arguments.

Output

FieldTypeRequiredDescription
knowledgeConnectorsobject[]YesKnowledge connectors in the organization.
knowledgeConnectors[].idstringYesThe knowledge connector ID.
knowledgeConnectors[].organizationIdstringYesThe organization ID.
knowledgeConnectors[].knowledgeBaseIdstring | nullNo
knowledgeConnectors[].namestringYesThe connector name.
knowledgeConnectors[].connectorTypestringYesThe connector type.
knowledgeConnectors[].descriptionstring | nullYesThe connector description, if any.
knowledgeConnectors[].enabledbooleanNo
knowledgeConnectors[].configanyYesThe provider-specific connector configuration.

get_knowledge_connector

Required RBAC permission: knowledgeSource:read

Input

ParameterTypeRequiredDescription
idstringYesKnowledge connector ID.

Output

FieldTypeRequiredDescription
knowledgeConnectorobjectYesThe requested knowledge connector.
knowledgeConnector.idstringYesThe knowledge connector ID.
knowledgeConnector.organizationIdstringYesThe organization ID.
knowledgeConnector.knowledgeBaseIdstring | nullNo
knowledgeConnector.namestringYesThe connector name.
knowledgeConnector.connectorTypestringYesThe connector type.
knowledgeConnector.descriptionstring | nullYesThe connector description, if any.
knowledgeConnector.enabledbooleanNo
knowledgeConnector.configanyYesThe provider-specific connector configuration.

update_knowledge_connector

Required RBAC permission: knowledgeSource:update

Input

ParameterTypeRequiredDescription
idstringYesKnowledge connector ID.
namestringNoNew connector name.
descriptionstring | nullNoNew connector description.
enabledbooleanNoWhether the connector is enabled.
visibility"org-wide" | "team-scoped" | "auto-sync-permissions"NoUpdated visibility for the connector.
team_idsstring[]NoUpdated team IDs for a team-scoped connector.
configobjectNoUpdated connector configuration (provider-specific settings).

Output

FieldTypeRequiredDescription
knowledgeConnectorobjectYesThe requested knowledge connector.
knowledgeConnector.idstringYesThe knowledge connector ID.
knowledgeConnector.organizationIdstringYesThe organization ID.
knowledgeConnector.knowledgeBaseIdstring | nullNo
knowledgeConnector.namestringYesThe connector name.
knowledgeConnector.connectorTypestringYesThe connector type.
knowledgeConnector.descriptionstring | nullYesThe connector description, if any.
knowledgeConnector.enabledbooleanNo
knowledgeConnector.configanyYesThe provider-specific connector configuration.

delete_knowledge_connector

Required RBAC permission: knowledgeSource:delete

Input

ParameterTypeRequiredDescription
idstringYesKnowledge connector ID.

assign_knowledge_connector_to_knowledge_base

Required RBAC permission: knowledgeSource:update

Input

ParameterTypeRequiredDescription
connector_idstringYesKnowledge connector ID.
knowledge_base_idstringYesKnowledge base ID.

unassign_knowledge_connector_from_knowledge_base

Required RBAC permission: knowledgeSource:update

Input

ParameterTypeRequiredDescription
connector_idstringYesKnowledge connector ID.
knowledge_base_idstringYesKnowledge base ID.

assign_knowledge_base_to_agent

Required RBAC permission: knowledgeSource:update

Input

ParameterTypeRequiredDescription
knowledge_base_idstringYesKnowledge base ID.
agent_idstringYesAgent ID.

unassign_knowledge_base_from_agent

Required RBAC permission: knowledgeSource:update

Input

ParameterTypeRequiredDescription
knowledge_base_idstringYesKnowledge base ID.
agent_idstringYesAgent ID.

assign_knowledge_connector_to_agent

Required RBAC permission: knowledgeSource:update

Input

ParameterTypeRequiredDescription
connector_idstringYesKnowledge connector ID.
agent_idstringYesAgent ID.

unassign_knowledge_connector_from_agent

Required RBAC permission: knowledgeSource:update

Input

ParameterTypeRequiredDescription
connector_idstringYesKnowledge connector ID.
agent_idstringYesAgent ID.

MCP Servers

ToolDescriptionPermission
search_private_mcp_registrySearch the private MCP registry for available MCP servers.mcpRegistry:read
get_mcp_serversList all MCP servers from the catalog.mcpRegistry:read
get_mcp_server_toolsGet all tools available for a specific MCP server by its catalog ID (from get_mcp_servers).mcpRegistry:read
edit_mcp_descriptionEdit an MCP server's display information and metadata.update on the MCP registry entry (granted per item)
edit_mcp_configEdit an MCP server's technical configuration.update on the MCP registry entry (granted per item)
create_mcp_serverCreate a new MCP server in the private registry.mcpRegistry:create
deploy_mcp_serverDeploy (install) an MCP server from the catalog.update on the MCP registry entry (granted per item)
list_mcp_server_deploymentsList deployed (installed) MCP server instances the current user can read.mcpRegistry:read
get_mcp_server_logsGet recent container logs from a deployed local (K8s) MCP server.mcpRegistry:read
reload_mcp_server_toolsRe-discover a deployed MCP server's tools from the live server and refresh Archestra's tool catalog for it — picks up added, removed, and changed tools (names, descriptions, and input schemas) with...mcpServerInstallation:create

search_private_mcp_registry

Required RBAC permission: mcpRegistry:read

Input

ParameterTypeRequiredDescription
querystringNoOptional search query to filter MCP servers by name or description.
accessstring[]NoOnly return items the caller reaches in one of these ways: mine (created by the caller), shared (shared with the caller or one of their teams), org (shared with the whole organization), others (not shared with the caller; visible only through admin access). Omit for everything the caller can read. Use ["mine"] for "my MCP servers".
shared_withstring[]NoOnly return items whose own permissions grant read to one of these subjects: org (the whole organization), role:, team:, user:, serviceAccount:. Omit for no filtering.
owner_idsstring[]NoOnly return items created by one of these user IDs. Omit for no filtering.

Output

FieldTypeRequiredDescription
itemsobject[]YesCatalog items matching the search.
items[].idstringYesThe catalog item ID.
items[].namestringYesThe MCP server name.
items[].versionstring | nullYesThe version, if provided.
items[].descriptionstring | nullYesThe server description, if any.
items[].serverType"local" | "remote" | "builtin" | "app"YesServer type: local, remote, builtin, or app (user-generated App).
items[].serverUrlstring | nullYesThe remote server URL, if applicable.
items[].repositorystring | nullYesThe repository URL, if available.

get_mcp_servers

Required RBAC permission: mcpRegistry:read

Input

ParameterTypeRequiredDescription
accessstring[]NoOnly return items the caller reaches in one of these ways: mine (created by the caller), shared (shared with the caller or one of their teams), org (shared with the whole organization), others (not shared with the caller; visible only through admin access). Omit for everything the caller can read. Use ["mine"] for "my MCP servers".
shared_withstring[]NoOnly return items whose own permissions grant read to one of these subjects: org (the whole organization), role:, team:, user:, serviceAccount:. Omit for no filtering.
owner_idsstring[]NoOnly return items created by one of these user IDs. Omit for no filtering.

Output

FieldTypeRequiredDescription
itemsobject[]YesAvailable MCP servers.
items[].idstringYesThe catalog item ID.
items[].namestringYesThe MCP server name.
items[].iconstring | nullYesThe emoji icon, if any.
items[].descriptionstring | nullYesThe server description, if any.
items[].scope"personal" | "team" | "org"NoThe visibility scope of the server.
items[].teamsobject[]YesTeams attached to a team-scoped server.
items[].teams[].idstringYesThe team ID.
items[].teams[].namestringYesThe team name.

get_mcp_server_tools

Required RBAC permission: mcpRegistry:read

Input

ParameterTypeRequiredDescription
mcpServerIdstringYesThe catalog ID of the MCP server.
view"full" | "picker"NoPicker metadata excludes parameter bodies and assigned-agent lists; defaults to full.

Output

FieldTypeRequiredDescription
toolsobject[]YesTools exposed by the selected MCP server.
tools[].idstringYesThe tool ID.
tools[].namestringYesThe tool name.
tools[].descriptionstring | nullNoThe tool description, if any.
tools[].catalogIdstring | nullNoThe MCP catalog ID this tool belongs to.

edit_mcp_description

Required RBAC permission: update on the MCP registry entry (granted per item)

Input

ParameterTypeRequiredDescription
idstringYesThe catalog ID of the MCP server to edit. Use get_mcp_servers to look it up by name.
namestringNoDisplay name for the MCP server.
descriptionstring | nullNoDescription of the MCP server.
iconstring | nullNoEmoji icon for the MCP server.
docsUrlstring | nullNoDocumentation URL.
repositorystring | nullNoSource code repository URL.
versionstring | nullNoVersion string.
instructionsstring | nullNoSetup or usage instructions.
labelsobject[]NoKey-value labels for organization/categorization.
labels[].keystringYesLabel key.
labels[].valuestringYesLabel value.

edit_mcp_config

Required RBAC permission: update on the MCP registry entry (granted per item)

Input

ParameterTypeRequiredDescription
idstringYesThe catalog ID of the MCP server to edit. Use get_mcp_servers to look it up by name.
serverType"local" | "remote" | "builtin"NoServer type: local, remote, or builtin.
serverUrlstring | nullNo[Remote] The URL of the remote MCP server.
requiresAuthbooleanNo[Remote] Whether the server requires authentication.
authDescriptionstring | nullNo[Remote] How to set up authentication.
authFieldsobject[]No[Remote] Authentication field definitions.
authFields[].namestringYesAuth field name.
authFields[].labelstringYesHuman-readable auth field label.
authFields[].type"header" | "query" | "cookie"YesWhere to send this auth field.
authFields[].secretbooleanYesWhether this field contains secret data.
oauthConfigobjectNo[Remote] OAuth configuration for the server.
commandstringNo[Local] Command to run (for example npx, uvx, or node).
argumentsstring[]No[Local] Command-line arguments.
environmentobject[]No[Local] Environment variables for the server process.
environment[].keystringYesEnvironment variable name.
environment[].type"plain_text" | "secret" | "boolean" | "number"YesEnvironment variable value type.
environment[].valuestringNoLiteral environment variable value.
environment[].promptOnInstallationbooleanYesWhether to prompt for this value during installation.
environment[].requiredbooleanNoWhether the value is required.
environment[].descriptionstringNoDescription shown to users.
environment[].defaultanyNoDefault value.
environment[].mountedbooleanNoFor secret values, mount as a file instead of an env var.
envFromobject[]No[Local] Import env vars from Kubernetes Secrets or ConfigMaps.
envFrom[].type"secret" | "configMap"YesImport source type.
envFrom[].namestringYesSecret or ConfigMap name.
envFrom[].prefixstringNoOptional environment variable prefix.
dockerImagestringNo[Local] Custom Docker image.
serviceAccountstringNo[Local] Kubernetes ServiceAccount name.
transportType"stdio" | "streamable-http"No[Local] Transport type. Omit it for remote servers: streamable-http is ignored and stdio is rejected.
httpPortnumberNo[Local] HTTP port for streamable-http transport.
httpPathstringNo[Local] HTTP path for streamable-http transport.
nodePortnumberNo[Local] Kubernetes NodePort for local development.
imagePullSecretsobject[]No[Local] Image pull secrets for private registries.
imagePullSecrets[].source"existing"YesImage pull secret source.
imagePullSecrets[].namestringYesExisting Kubernetes secret name.
imagePullPolicy"Always" | "IfNotPresent" | "Never"No[Local] Kubernetes imagePullPolicy for the server container. Unset uses Always for :latest or untagged images and IfNotPresent otherwise.
deploymentSpecYamlstringNo[Local] Custom Kubernetes deployment YAML override.
installationCommandstringNo[Local] Command to install the MCP server package.
userConfigobjectNoUser-configurable fields shown during installation.

create_mcp_server

Required RBAC permission: mcpRegistry:create

Input

ParameterTypeRequiredDescription
namestringYesDisplay name for the MCP server.
descriptionstring | nullNoDescription of the MCP server.
iconstring | nullNoEmoji icon for the MCP server.
docsUrlstring | nullNoDocumentation URL.
repositorystring | nullNoSource code repository URL.
versionstring | nullNoVersion string.
instructionsstring | nullNoSetup or usage instructions.
labelsobject[]NoKey-value labels for organization/categorization.
labels[].keystringYesLabel key.
labels[].valuestringYesLabel value.
environmentIdstring | nullNoID of the environment this server belongs to. Pass null for the default environment. Omit it to use your own environment, or the organization's landing environment for new MCP servers when you have none.
initialGrantsobject[]No
initialGrants[].subjectobjectYes
initialGrants[].subject.type"user" | "team" | "serviceAccount" | "role" | "organization"Yes
initialGrants[].subject.idstring | "*"Yes
initialGrants[].actionsstring[]Yes
serverType"local" | "remote" | "builtin"NoServer type: local, remote, or builtin.
serverUrlstring | nullNo[Remote] The URL of the remote MCP server.
requiresAuthbooleanNo[Remote] Whether the server requires authentication.
authDescriptionstring | nullNo[Remote] How to set up authentication.
authFieldsobject[]No[Remote] Authentication field definitions.
authFields[].namestringYesAuth field name.
authFields[].labelstringYesHuman-readable auth field label.
authFields[].type"header" | "query" | "cookie"YesWhere to send this auth field.
authFields[].secretbooleanYesWhether this field contains secret data.
oauthConfigobjectNo[Remote] OAuth configuration for the server.
commandstringNo[Local] Command to run (for example npx, uvx, or node).
argumentsstring[]No[Local] Command-line arguments.
environmentobject[]No[Local] Environment variables for the server process.
environment[].keystringYesEnvironment variable name.
environment[].type"plain_text" | "secret" | "boolean" | "number"YesEnvironment variable value type.
environment[].valuestringNoLiteral environment variable value.
environment[].promptOnInstallationbooleanYesWhether to prompt for this value during installation.
environment[].requiredbooleanNoWhether the value is required.
environment[].descriptionstringNoDescription shown to users.
environment[].defaultanyNoDefault value.
environment[].mountedbooleanNoFor secret values, mount as a file instead of an env var.
envFromobject[]No[Local] Import env vars from Kubernetes Secrets or ConfigMaps.
envFrom[].type"secret" | "configMap"YesImport source type.
envFrom[].namestringYesSecret or ConfigMap name.
envFrom[].prefixstringNoOptional environment variable prefix.
dockerImagestringNo[Local] Custom Docker image.
serviceAccountstringNo[Local] Kubernetes ServiceAccount name.
transportType"stdio" | "streamable-http"No[Local] Transport type. Omit it for remote servers: streamable-http is ignored and stdio is rejected.
httpPortnumberNo[Local] HTTP port for streamable-http transport.
httpPathstringNo[Local] HTTP path for streamable-http transport.
nodePortnumberNo[Local] Kubernetes NodePort for local development.
imagePullSecretsobject[]No[Local] Image pull secrets for private registries.
imagePullSecrets[].source"existing"YesImage pull secret source.
imagePullSecrets[].namestringYesExisting Kubernetes secret name.
imagePullPolicy"Always" | "IfNotPresent" | "Never"No[Local] Kubernetes imagePullPolicy for the server container. Unset uses Always for :latest or untagged images and IfNotPresent otherwise.
deploymentSpecYamlstringNo[Local] Custom Kubernetes deployment YAML override.
installationCommandstringNo[Local] Command to install the MCP server package.
userConfigobjectNoUser-configurable fields shown during installation.

deploy_mcp_server

Required RBAC permission: update on the MCP registry entry (granted per item)

Input

ParameterTypeRequiredDescription
catalogIdstringYesThe catalog ID of the MCP server to deploy.
scope"personal" | "team" | "org"NoVisibility scope for the deployment: 'personal' (default), 'team' (requires teamId), or 'org' (admins only, visible to all org members).
teamIdstringNoOptional team ID for a team-scoped deployment (required when scope='team').
agentIdsstring[]NoOptional agent IDs to assign the server's tools to after deployment.

list_mcp_server_deployments

Required RBAC permission: mcpRegistry:read

This tool takes no arguments.

get_mcp_server_logs

Required RBAC permission: mcpRegistry:read

Input

ParameterTypeRequiredDescription
serverIdstringYesThe deployment ID of the MCP server.
linesintegerNoNumber of log lines to retrieve.

reload_mcp_server_tools

Required RBAC permission: mcpServerInstallation:create

Input

ParameterTypeRequiredDescription
serverIdstringYesThe deployment ID of the MCP server whose tools should be refreshed. Use list_mcp_server_deployments to find it.

MCP Gateways

ToolDescriptionPermission
create_mcp_gatewayCreate a new MCP gateway with the specified name, optional labels, and optional assigned knowledge bases or knowledge connectors.mcpGateway:create
get_mcp_gatewayGet a specific MCP gateway by ID or name.mcpGateway:read
edit_mcp_gatewayEdit an existing MCP gateway.update on the MCP gateway (granted per item)

create_mcp_gateway

Required RBAC permission: mcpGateway:create

Input

ParameterTypeRequiredDescription
initialGrantsobject[]No
initialGrants[].subjectobjectYes
initialGrants[].subject.type"user" | "team" | "serviceAccount" | "role" | "organization"Yes
initialGrants[].subject.idstring | "*"Yes
initialGrants[].actionsstring[]Yes
namestringYesName for the new resource.
labelsobject[]NoOptional key-value labels for organization and categorization.
labels[].keystringYes
labels[].valuestringYes
toolExposureMode"full" | "search_and_run_only"NoHow tools should be loaded for MCP clients and models.
accessAllToolsbooleanNoAllow dynamic tool access: search_tools/run_tool may discover and run any tool the calling user can access (MCP catalog tools and knowledge sources) without assigning it to the agent. Enabling this forces toolExposureMode to 'search_and_run_only', since dynamic access only works through the search/run dispatch surface. Defaults to false. Also gated by the organization's security settings.
accessAllSubagentsbooleanNoAllow dynamic subagent delegation: the agent may delegate to any internal agent the calling user can access, beyond explicitly-configured delegation targets (minus subagent exclusions). Defaults to false.
knowledgeBaseIdsstring[]NoKnowledge base IDs to assign to the agent. Use get_knowledge_bases first when you need to look up IDs by name.
connectorIdsstring[]NoKnowledge connector IDs to assign directly to the agent. Use get_knowledge_connectors first when you need to look up IDs by name.
subAgentIdsstring[]NoOptional list of agent IDs that this MCP gateway can delegate to as subagents.

get_mcp_gateway

Required RBAC permission: mcpGateway:read

Input

ParameterTypeRequiredDescription
idstringNoThe ID of the MCP gateway to fetch. Prefer the ID when you already have it.
namestringNoThe exact name of the MCP gateway to fetch when you do not already have the ID.

Output

FieldTypeRequiredDescription
idstringYesThe resource ID.
namestringYesThe resource name.
descriptionstring | nullYesThe resource description, if any.
iconstring | nullYesThe emoji icon, if configured.
scope"personal" | "team" | "org"YesThe visibility scope.
toolExposureMode"full" | "search_and_run_only"YesHow tools are loaded for MCP clients and models.
accessAllToolsbooleanYesWhether search_tools/run_tool may dynamically access every tool the calling user can access.
accessAllSubagentsbooleanYesWhether the agent may delegate to every internal agent the calling user can access.
agentType"agent" | "llm_proxy" | "mcp_gateway" | "profile"YesThe resource type.
systemPromptstring | nullNo
teamsobject[]YesThe teams attached to it.
teams[].idstringYesThe team ID.
teams[].namestringYesThe team name.
labelsobject[]YesAssigned labels.
labels[].keystringYesThe label key.
labels[].valuestringYesThe label value.
toolsobject[]YesAssigned tools.
tools[].idstringYesThe assigned tool ID.
tools[].namestringYesThe tool name.
tools[].descriptionstring | nullYesThe tool description, if any.
tools[].catalogIdstring | nullYesThe MCP catalog ID the tool comes from, if any.
knowledgeBaseIdsstring[]YesAssigned knowledge base IDs.
connectorIdsstring[]YesAssigned knowledge connector IDs.
suggestedPromptsobject[]YesConfigured suggested prompts.
suggestedPrompts[].summaryTitlestringYesThe short title shown in the chat UI.
suggestedPrompts[].promptstringYesThe suggested prompt text.

edit_mcp_gateway

Required RBAC permission: update on the MCP gateway (granted per item)

Input

ParameterTypeRequiredDescription
idstringYesThe ID of the MCP gateway to edit. Use get_mcp_gateway to look it up by name first if needed.
descriptionstring | nullNoNew description for the MCP gateway.
iconstring | nullNoNew emoji icon for the MCP gateway.
labelsobject[]NoReplace the MCP gateway's labels with this set.
labels[].keystringYes
labels[].valuestringYes
namestringNoNew name for the MCP gateway.
toolExposureMode"full" | "search_and_run_only"NoHow tools should be loaded for MCP clients and models.
accessAllToolsbooleanNoAllow dynamic tool access: search_tools/run_tool may discover and run any tool the calling user can access (MCP catalog tools and knowledge sources) without assigning it to the agent. Enabling this forces toolExposureMode to 'search_and_run_only', since dynamic access only works through the search/run dispatch surface. Defaults to false. Also gated by the organization's security settings.
accessAllSubagentsbooleanNoAllow dynamic subagent delegation: the agent may delegate to any internal agent the calling user can access, beyond explicitly-configured delegation targets (minus subagent exclusions). Defaults to false.
knowledgeBaseIdsstring[]NoReplace the MCP gateway's assigned knowledge bases with this set.
connectorIdsstring[]NoReplace the MCP gateway's directly assigned knowledge connectors with this set.
subAgentIdsstring[]NoOptional list of agent IDs that this MCP gateway can delegate to as subagents.

Tool Assignment

ToolDescriptionPermission
bulk_assign_tools_to_agentsAssign multiple tools to multiple agents in bulk with validation and error handlingupdate on the agent (granted per item)
bulk_remove_tools_from_agentsRemove multiple tools from multiple agents in bulk.update on the agent (granted per item)
bulk_assign_tools_to_mcp_gatewaysAssign multiple tools to multiple MCP gateways in bulk with validation and error handlingupdate on the MCP gateway (granted per item)

bulk_assign_tools_to_agents

Required RBAC permission: update on the agent (granted per item)

Input

ParameterTypeRequiredDescription
assignmentsobject[]YesAssignments to create or update for agents.
assignments[].toolIdstringYesThe ID of the tool to assign.
assignments[].resolveAtCallTimebooleanNoWhen true, resolve credentials and execution target at tool call time. Prefer this for builder flows.
assignments[].credentialResolutionMode"static" | "dynamic" | "enterprise_managed"No
assignments[].mcpServerIdstring | nullNoOptional MCP server installation to pin the tool to when using static credential resolution.
assignments[].agentIdstringYesThe agent ID to assign the tool to.

Output

FieldTypeRequiredDescription
succeededobject[]YesAssignments that succeeded.
succeeded[].agentIdstringYesThe target agent ID.
succeeded[].toolIdstringYesThe tool ID.
succeeded[].errorstringNoValidation or assignment error.
succeeded[].errorCode"not_found" | "validation_error" | "forbidden"NoStructured assignment error code.
succeeded[].errorTypestringNoStructured assignment error type.
failedobject[]YesAssignments that failed.
failed[].agentIdstringYesThe target agent ID.
failed[].toolIdstringYesThe tool ID.
failed[].errorstringNoValidation or assignment error.
failed[].errorCode"not_found" | "validation_error" | "forbidden"NoStructured assignment error code.
failed[].errorTypestringNoStructured assignment error type.
duplicatesobject[]YesAssignments skipped because they already existed.
duplicates[].agentIdstringYesThe target agent ID.
duplicates[].toolIdstringYesThe tool ID.
duplicates[].errorstringNoValidation or assignment error.
duplicates[].errorCode"not_found" | "validation_error" | "forbidden"NoStructured assignment error code.
duplicates[].errorTypestringNoStructured assignment error type.

bulk_remove_tools_from_agents

Required RBAC permission: update on the agent (granted per item)

Input

ParameterTypeRequiredDescription
removalsobject[]YesTool removals to apply to agents.
removals[].agentIdstringYesThe agent ID to remove the tool from.
removals[].toolIdstringYesThe ID of the tool to remove.

Output

FieldTypeRequiredDescription
succeededobject[]YesRemovals that took effect.
succeeded[].agentIdstringYesThe target agent ID.
succeeded[].toolIdstringYesThe tool ID.
succeeded[].errorstringNoPermission or removal error.
notAssignedobject[]YesRemovals skipped because the tool was not assigned to the agent (Custom mode).
notAssigned[].agentIdstringYesThe target agent ID.
notAssigned[].toolIdstringYesThe tool ID.
notAssigned[].errorstringNoPermission or removal error.
failedobject[]YesRemovals that failed (e.g. no permission, agent not found, or a tool that cannot be excluded).
failed[].agentIdstringYesThe target agent ID.
failed[].toolIdstringYesThe tool ID.
failed[].errorstringNoPermission or removal error.

bulk_assign_tools_to_mcp_gateways

Required RBAC permission: update on the MCP gateway (granted per item)

Input

ParameterTypeRequiredDescription
assignmentsobject[]YesAssignments to create or update for MCP gateways.
assignments[].toolIdstringYesThe ID of the tool to assign.
assignments[].resolveAtCallTimebooleanNoWhen true, resolve credentials and execution target at tool call time. Prefer this for builder flows.
assignments[].credentialResolutionMode"static" | "dynamic" | "enterprise_managed"No
assignments[].mcpServerIdstring | nullNoOptional MCP server installation to pin the tool to when using static credential resolution.
assignments[].mcpGatewayIdstringYesThe MCP gateway ID to assign the tool to.

Output

FieldTypeRequiredDescription
succeededobject[]YesAssignments that succeeded.
succeeded[].mcpGatewayIdstringYesThe target MCP gateway ID.
succeeded[].toolIdstringYesThe tool ID.
succeeded[].errorstringNoValidation or assignment error.
succeeded[].errorCode"not_found" | "validation_error" | "forbidden"NoStructured assignment error code.
succeeded[].errorTypestringNoStructured assignment error type.
failedobject[]YesAssignments that failed.
failed[].mcpGatewayIdstringYesThe target MCP gateway ID.
failed[].toolIdstringYesThe tool ID.
failed[].errorstringNoValidation or assignment error.
failed[].errorCode"not_found" | "validation_error" | "forbidden"NoStructured assignment error code.
failed[].errorTypestringNoStructured assignment error type.
duplicatesobject[]YesAssignments skipped because they already existed.
duplicates[].mcpGatewayIdstringYesThe target MCP gateway ID.
duplicates[].toolIdstringYesThe tool ID.
duplicates[].errorstringNoValidation or assignment error.
duplicates[].errorCode"not_found" | "validation_error" | "forbidden"NoStructured assignment error code.
duplicates[].errorTypestringNoStructured assignment error type.