veryfront__search_knowledgeget_file before answering knowledge questions.
Access
No external-service connection is required. Use a Veryfront credential with access to the requested resources. Call type: Read-only.Arguments
| Field | Type | Required | Description and constraints |
|---|---|---|---|
query | string | Yes | Text to match against knowledge file paths and frontmatter. On the first request, provide query without cursor. Minimum length: 1. Maximum length: 500. |
cursor | string | No | Opaque pagination token. Omit on the first request. To continue REST or MCP pagination, pass page_info.next from the previous response as cursor. Minimum length: 1. Maximum length: 13334. |
lookup_target | object or object or object | No | Optional. Omit to search the main preview branch (the default). Set this to target another preview branch, a deployed environment, or a published release; unresolved targets are returned as not found. |
limit | integer | No | Maximum number of results to return. Minimum: 1. Maximum: 12. |
shard_count | integer | No | Provide the shard count. Minimum: 1. Maximum: 8. |
shard_index | integer | No | Provide the shard index. Minimum: 0. |
project_reference | string | No | Project identifier or slug that scopes the tool call. |
Example request
Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.request.json
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "veryfront__search_knowledge",
"arguments": {
"query": "example"
}
}
}
Result
The published output shape is summarized below. Inspect both the MCP response content andisError when handling a call.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
query | string | Yes | Resolved query used for scoring. |
mode | string | Yes | search when results scored positively; browse when no positive matches exist. Values: "search", "browse". |
data | object[] | Yes | Knowledge Markdown paths with frontmatter previews. |
page_info | object | Yes | Pagination cursor values for traversing the result set. |
returned | integer | Yes | Minimum: 0. |
total_matches | integer | Yes | Total number of matches found by the tool. Minimum: 0. |
shard | object | Yes | Structured shard details associated with this tool result. |
Full schemas
{
"type": "object",
"properties": {
"query": {
"type": "string",
"minLength": 1,
"maxLength": 500,
"description": "Text to match against knowledge file paths and frontmatter. On the first request, provide query without cursor."
},
"cursor": {
"type": "string",
"minLength": 1,
"maxLength": 13334,
"description": "Opaque pagination token. Omit on the first request. To continue REST or MCP pagination, pass page_info.next from the previous response as cursor."
},
"lookup_target": {
"anyOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "preview_branch",
"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 to search. Omit or use null for the main branch (the default)."
}
},
"required": [
"kind"
],
"additionalProperties": false,
"description": "Search a working branch, the default scope when lookup_target is omitted."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "environment",
"description": "Provide the kind."
},
"environment_id": {
"type": "string",
"format": "uuid",
"description": "ID of the environment whose deployed release to search."
},
"environment_name": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Name of the environment (for example \"production\") whose deployed release to search."
}
},
"required": [
"kind"
],
"additionalProperties": false,
"description": "Search the release currently deployed to an environment. Provide environment_id or environment_name."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "release",
"description": "Provide the kind."
},
"release_id": {
"type": "string",
"format": "uuid",
"description": "ID of the release to search."
},
"release_version": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Version string of the release to search."
}
},
"required": [
"kind"
],
"additionalProperties": false,
"description": "Search a specific published release. Provide release_id or release_version."
}
],
"description": "Optional. Omit to search the main preview branch (the default). Set this to target another preview branch, a deployed environment, or a published release; unresolved targets are returned as not found."
},
"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."
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"query"
],
"description": "Arguments for the search_knowledge tool."
}
{
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "Resolved query used for scoring."
},
"mode": {
"type": "string",
"enum": [
"search",
"browse"
],
"description": "search when results scored positively; browse when no positive matches exist."
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Knowledge Markdown file path."
},
"matched_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Matched fields. May include path and frontmatter keys, including keys not present in the returned preview."
},
"frontmatter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Frontmatter key."
},
"value": {
"type": "string",
"description": "Frontmatter value. Returned preview values may be truncated."
}
},
"required": [
"key",
"value"
],
"additionalProperties": false
},
"description": "Preview of prioritized frontmatter: at most six fields, with values truncated to 160 characters."
}
},
"required": [
"path",
"matched_fields",
"frontmatter"
],
"additionalProperties": false
},
"description": "Knowledge Markdown paths with frontmatter previews."
},
"page_info": {
"type": "object",
"properties": {
"self": {
"type": [
"string",
"null"
],
"description": "Cursor supplied on this request, if any."
},
"first": {
"type": "object",
"description": "Reserved; first-page cursor is not emitted."
},
"next": {
"type": [
"string",
"null"
],
"description": "Opaque cursor for the next REST or MCP page, if more results are available."
},
"prev": {
"type": [
"string",
"null"
],
"description": "Reserved; previous-page cursor is not emitted."
}
},
"required": [
"self",
"first",
"next",
"prev"
],
"additionalProperties": false,
"description": "Pagination cursor values for traversing the result set."
},
"returned": {
"type": "integer",
"minimum": 0
},
"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
},
"shard_count": {
"type": "integer",
"minimum": 1
},
"total_items": {
"type": "integer",
"minimum": 0
}
},
"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#"
}