Tool details
| Field | Value |
|---|---|
| Name | list_agent_tool_references |
| Group | Agents |
Playground
Input schema
input-schema.json
{
"type": "object",
"properties": {
"project_reference": {
"type": "string",
"minLength": 1,
"description": "Project ID or slug whose agent source is being authored."
},
"query": {
"type": "string",
"minLength": 1,
"description": "Focused text query matched against valid tool reference names and descriptions."
},
"names": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"description": "Exact tool reference name to validate."
},
"minItems": 1,
"maxItems": 20,
"description": "Exact candidate names to return when they are valid for agent tool_ids."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 50,
"description": "Maximum number of compact references to return. Defaults to 20; maximum is 50."
},
"source_target_kind": {
"type": "string",
"description": "The source target kind associated with this record."
},
"target_branch_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "The target branch id associated with this record."
},
{
"type": "null",
"description": "Provide the target branch id."
}
],
"description": "The target branch id associated with this record."
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Input schema for the list_agent_tool_references tool."
}
Output schema
output-schema.json
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Exact reference name to use in agent tool_ids."
},
"description": {
"type": "string",
"description": "Compact purpose of the referenced tool."
},
"source": {
"type": "string",
"enum": [
"platform",
"project",
"integration"
],
"description": "Control-plane source that makes this tool reference valid for the selected project target."
},
"attach_via": {
"type": "string",
"const": "tool_ids",
"description": "Agent field used to attach this reference."
}
},
"required": [
"name",
"description",
"source",
"attach_via"
],
"additionalProperties": false,
"description": "Schema-free tool reference that can be attached to a project agent."
},
"description": "Deterministically ranked and deduplicated matching tool references."
},
"returned": {
"type": "integer",
"minimum": 0,
"description": "Number of references returned after applying the limit."
},
"total_matches": {
"type": "integer",
"minimum": 0,
"description": "Total matching references before applying the limit."
}
},
"required": [
"data",
"returned",
"total_matches"
],
"additionalProperties": false,
"description": "Compact schema-free agent tool reference search result.",
"$schema": "http://json-schema.org/draft-07/schema#"
}