Tool details
| Field | Value |
|---|---|
| Name | search_knowledge |
| Group | Knowledge |
Playground
Input schema
Input schema
{
"type": "object",
"properties": {
"query": {
"type": "string",
"minLength": 1,
"maxLength": 500,
"description": "Search query or free-form prompt for the tool."
},
"cursor": {
"type": "string",
"minLength": 1,
"maxLength": 13334,
"description": "Opaque pagination cursor returned by a previous response."
},
"lookup_target": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"preview_branch",
"environment",
"release"
],
"description": "Provide the kind."
},
"branch_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Branch identifier. Use null for the main branch when the tool supports it."
},
{
"type": "null",
"description": "Branch identifier. Use null for the main branch when the tool supports it."
}
],
"description": "Branch identifier. Use null for the main branch when the tool supports it."
},
"environment_id": {
"type": "string",
"format": "uuid",
"description": "Provide the environment id."
},
"environment_name": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Provide the environment name."
},
"release_id": {
"type": "string",
"format": "uuid",
"description": "Release identifier used to scope the request."
},
"release_version": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Release version string used to scope the request."
}
},
"required": [
"kind"
],
"additionalProperties": false,
"description": "Provide the lookup target."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 12,
"description": "Maximum number of results to return."
},
"shard_count": {
"type": "integer",
"minimum": 1,
"maximum": 8,
"description": "Provide the shard count."
},
"shard_index": {
"type": "integer",
"minimum": 0,
"description": "Provide the shard index."
},
"project_reference": {
"type": "string",
"description": "Project identifier or slug that scopes the tool call."
}
},
"required": [
"project_reference"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Input schema for the search_knowledge tool."
}
Output schema
Output schema
{
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "Query string associated with this result."
},
"mode": {
"type": "string",
"enum": [
"search",
"browse"
],
"description": "The mode associated with this tool result."
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "The path associated with this tool result."
},
"matched_fields": {
"type": "array",
"items": {
"type": "string",
"description": "One matched field item associated with this tool result."
},
"description": "List of matched fields associated with this tool result."
},
"frontmatter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The key associated with this tool result."
},
"value": {
"type": "string",
"description": "The value associated with this tool result."
}
},
"required": [
"key",
"value"
],
"additionalProperties": false,
"description": "One frontmatter item associated with this tool result."
},
"description": "List of frontmatter associated with this tool result."
}
},
"required": [
"path",
"matched_fields",
"frontmatter"
],
"additionalProperties": false,
"description": "One data item associated with this tool result."
},
"description": "Primary result records returned by the tool."
},
"page_info": {
"type": "object",
"properties": {
"self": {
"type": [
"string",
"null"
],
"description": "Cursor that refers to the current page."
},
"first": {
"type": "object",
"description": "The first associated with this tool result."
},
"next": {
"type": [
"string",
"null"
],
"description": "Cursor for the next page when pagination is available."
},
"prev": {
"type": [
"string",
"null"
],
"description": "Cursor for the previous page when pagination is available."
}
},
"required": [
"self",
"first",
"next",
"prev"
],
"additionalProperties": false,
"description": "Pagination cursor values for traversing the result set."
},
"returned": {
"type": "integer",
"minimum": 0,
"description": "The returned associated with this tool result."
},
"total_matches": {
"type": "integer",
"minimum": 0,
"description": "Total number of matches found by the tool."
},
"shard": {
"type": "object",
"properties": {
"shard_index": {
"type": "integer",
"minimum": 0,
"description": "The shard index associated with this tool result."
},
"shard_count": {
"type": "integer",
"minimum": 1,
"description": "The shard count associated with this tool result."
},
"total_items": {
"type": "integer",
"minimum": 0,
"description": "The total items associated with this tool result."
}
},
"required": [
"shard_index",
"shard_count",
"total_items"
],
"additionalProperties": false,
"description": "Structured shard details associated with this tool result."
}
},
"required": [
"query",
"mode",
"data",
"page_info",
"returned",
"total_matches",
"shard"
],
"additionalProperties": false,
"description": "Structured result returned by the search_knowledge tool.",
"$schema": "http://json-schema.org/draft-07/schema#"
}