List knowledge files - Veryfront

veryfront__list_knowledge_catalog

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
`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.
`caller_selector`	`boolean or string or string[] or object`	No	Caller-selected document scope. Source membership, persisted run knowledge policy and this selector are intersected before counting or paging. Results include visible knowledge Markdown files with title, type, tags and link counts. Accepts a boolean, a path pattern, a list of patterns, or a {pattern: boolean} map. Patterns are relative; at most 1024 entries.
`filters`	`object`	No	Provide the filters.
`pagination`	`object`	No	Provide the pagination.
`project_reference`	`string`	No	Project whose knowledge is selected. Ordinary callers require project.knowledge.read. A run-bound MCP service credential instead must match the persisted run’s project and agent plus its actor or runtime transport binding; its effective sealed authority must grant the invoked tool and a knowledge selector. On project-scoped MCP endpoints, the scoped project supplies this value when omitted. Minimum length: `1`.

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__list_knowledge_catalog",
    "arguments": {}
  }
}

Result

The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.

Field	Type	Required	Description and constraints
`data`	`object[]`	Yes	Primary result records returned by the tool.
`total`	`integer`	Yes	Minimum: `0`.
`returned`	`integer`	Yes	Minimum: `0`.
`page_info`	`object`	Yes	Pagination cursor values for traversing the result set.

Full schemas

{
  "type": "object",
  "properties": {
    "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."
    },
    "caller_selector": {
      "anyOf": [
        {
          "type": "boolean",
          "description": "Provide the option 1."
        },
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 4096,
          "description": "Provide the option 2."
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/properties/caller_selector/anyOf/1",
            "description": "One caller selector item supplied to the tool."
          },
          "maxItems": 1024,
          "description": "Provide one or more option 3 values."
        },
        {
          "type": "object",
          "additionalProperties": {
            "type": "boolean",
            "description": "Additional structured values supplied to the tool."
          },
          "description": "Provide the option 4."
        }
      ],
      "description": "Caller-selected document scope. Source membership, persisted run knowledge policy and this selector are intersected before counting or paging. Results include visible knowledge Markdown files with title, type, tags and link counts. Accepts a boolean, a path pattern, a list of patterns, or a {pattern: boolean} map. Patterns are relative; at most 1024 entries."
    },
    "filters": {
      "type": "object",
      "properties": {
        "search": {
          "type": "string",
          "minLength": 1,
          "maxLength": 256,
          "description": "Case-insensitive title or path search within the authorized source."
        },
        "type": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128,
          "description": "Provide the type."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128,
            "description": "One tag item supplied to the tool."
          },
          "maxItems": 64,
          "description": "Provide the tags."
        }
      },
      "additionalProperties": false,
      "description": "Provide the filters."
    },
    "pagination": {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "minimum": 1,
          "maximum": 100,
          "description": "Maximum number of results to return."
        },
        "cursor": {
          "type": "string",
          "minLength": 1,
          "maxLength": 2048,
          "description": "Opaque pagination cursor returned by a previous response."
        }
      },
      "additionalProperties": false,
      "description": "Provide the pagination."
    },
    "project_reference": {
      "type": "string",
      "minLength": 1,
      "description": "Project whose knowledge is selected. Ordinary callers require project.knowledge.read. A run-bound MCP service credential instead must match the persisted run's project and agent plus its actor or runtime transport binding; its effective sealed authority must grant the invoked tool and a knowledge selector. On project-scoped MCP endpoints, the scoped project supplies this value when omitted."
    }
  },
  "additionalProperties": false,
  "description": "Arguments for the list_knowledge_catalog tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "file_id": {
            "type": "string",
            "format": "uuid"
          },
          "file_version_id": {
            "type": "string",
            "format": "uuid"
          },
          "path": {
            "type": "string"
          },
          "title": {
            "type": [
              "string",
              "null"
            ],
            "description": "Short human-readable title returned by the tool."
          },
          "type": {
            "type": [
              "string",
              "null"
            ]
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of tags associated with this tool result."
          },
          "reserved": {
            "type": "boolean"
          },
          "reserved_kind": {
            "type": [
              "string",
              "null"
            ]
          },
          "malformed_reason": {
            "type": [
              "string",
              "null"
            ]
          },
          "links": {
            "type": "object",
            "properties": {
              "document_edges": {
                "type": "integer",
                "minimum": 0
              },
              "external_links": {
                "type": "integer",
                "minimum": 0
              },
              "broken_links": {
                "type": "integer",
                "minimum": 0
              }
            },
            "required": [
              "document_edges",
              "external_links",
              "broken_links"
            ],
            "additionalProperties": false,
            "description": "Structured links details associated with this tool result."
          }
        },
        "required": [
          "file_id",
          "file_version_id",
          "path",
          "title",
          "type",
          "tags",
          "reserved",
          "reserved_kind",
          "malformed_reason",
          "links"
        ],
        "additionalProperties": false
      },
      "description": "Primary result records returned by the tool."
    },
    "total": {
      "type": "integer",
      "minimum": 0
    },
    "returned": {
      "type": "integer",
      "minimum": 0
    },
    "page_info": {
      "type": "object",
      "properties": {
        "self": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor supplied on this request, if any."
        },
        "first": {
          "type": "object",
          "description": "Reserved; a first-page cursor is not emitted."
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "Opaque cursor for the next page, or null on the last page."
        },
        "prev": {
          "type": "object",
          "description": "Reserved; a previous-page cursor is not emitted."
        }
      },
      "required": [
        "self",
        "first",
        "next",
        "prev"
      ],
      "additionalProperties": false,
      "description": "Pagination cursor values for traversing the result set."
    }
  },
  "required": [
    "data",
    "total",
    "returned",
    "page_info"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the list_knowledge_catalog tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}