Omit a tool
Transitions a tool to STATE_OMITTED, excluding it from agent use. Fails if the tool is currently assigned to agent variations.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Workspace ID.
"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
Tool set ID. Accepts the canonical ts_… form or the external_id: form.
"toolset_01HXKD2E5NQM3T9AYWCFNRMN74"
Tool ID. Accepts the canonical tool_… form or the external_id: form.
"tool_01HXKD2E5NQM3T9AYWCFWVYY9K"
Body
Omit tool request
Response
OK
Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
The current lifecycle state of the tool. Output only. Use the :omit and :restore actions to transition; tool set syncs may also update it.
STATE_UNSPECIFIED, STATE_AVAILABLE, STATE_OMITTED, STATE_ARCHIVED