Pipedream · Schema
ToolAnnotations
Optional properties describing component behavior
ProCode_API_CompositionWorkflowsConnectMCPEmbedded IntegrationsManaged AuthAI Agents
Properties
| Name | Type | Description |
|---|---|---|
| destructiveHint | boolean | If true, the component may perform destructive updates to its environment. If false, the component performs only additive updates. |
| idempotentHint | boolean | If true, calling the component repeatedly with the same arguments will have no additional effect on the its environment. |
| openWorldHint | boolean | If true, this component may interact with an “open world” of external entities. If false, the component's domain of interaction is closed. For example, the world of a web search component is open, whe |
| readOnlyHint | boolean | If true, the component does not modify its environment. |
| title | string | A human-readable title for the component. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/ToolAnnotations",
"title": "ToolAnnotations",
"type": "object",
"description": "Optional properties describing component behavior",
"nullable": true,
"properties": {
"destructiveHint": {
"type": "boolean",
"description": "If true, the component may perform destructive updates to its environment. If false, the component performs only additive updates.",
"nullable": true
},
"idempotentHint": {
"type": "boolean",
"description": "If true, calling the component repeatedly with the same arguments will have no additional effect on the its environment.",
"nullable": true
},
"openWorldHint": {
"type": "boolean",
"description": "If true, this component may interact with an \u201copen world\u201d of external entities. If false, the component's domain of interaction is closed. For example, the world of a web search component is open, whereas that of a memory component is not.",
"nullable": true
},
"readOnlyHint": {
"type": "boolean",
"description": "If true, the component does not modify its environment.",
"nullable": true
},
"title": {
"type": "string",
"description": "A human-readable title for the component.",
"nullable": true
}
}
}