> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Search project definitions

> Search project source definitions by ID or display name.

`veryfront__search_project_definitions`

## 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 |
| - | - | - | - |
| `runtime_target_kind` | `string or null` | No | Provide the runtime target kind. |
| `target_environment_id` | `string or null` | No | Provide the target environment id. |
| `target_branch_id` | `string or null` | No | Provide the target branch id. |
| `source_target_kind` | `string` | No | Provide the source target kind. Values: `"project"`, `"main_branch"`, `"environment"`, `"preview_branch"`. |
| `identity` | `string` | No | Exact definition ID or display name. Omit to browse. Minimum length: `1`. Maximum length: `4096`. |
| `kinds` | `string[]` | No | Source definition kinds to inspect. Display names do not establish kind. When the kind is unknown, omit this filter to inspect all source kinds; coverage reports access and completeness for each kind. |
| `limit` | `integer` | No | Maximum number of results to return. Minimum: `1`. Maximum: `50`. |
| `cursor` | `string` | No | Opaque pagination cursor returned by a previous response. Minimum length: `1`. Maximum length: `512`. |
| `project_reference` | `string` | No | Project identifier or slug that scopes the tool call. 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](https://veryfront.com/docs/cloud/getting-started/connect-mcp.md).

```json title="request.json" theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__search_project_definitions",
    "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 | Saved project source definitions, not executable tools. A display name does not establish its kind; read a definition with its reader operation and identity. |
| `total_matches` | `integer` | Yes | Total number of matches found by the tool. Minimum: `0`. |
| `page_info` | `object` | Yes | Pagination cursor values for traversing the result set. |
| `resolution` | `string` | Yes | Lookup result for the requested kinds at the selected source target. `not_found` means no matching identity in those kinds only when their coverage is complete; it does not rule out other kinds or targets. Values: `"listed"`, `"found"`, `"ambiguous"`, `"not_found"`, `"incomplete"`. |
| `suggested_query` | `object` | No | For a complete miss with an explicit kind filter, retry this exact identity and source target without kinds. This does not imply a match exists in another kind. |
| `kind_filter_miss` | `object` | No | Present when the identity was absent from the requested kinds but exists in another kind. data, coverage, resolution and `page_info` then describe the unfiltered lookup; use each match kind and reader, not the requested kinds. To continue, re-send the same query (with or without kinds) and `page_info`.next; the widening is re-applied. |
| `coverage` | `object[]` | Yes | Discovery coverage for the requested kinds at the selected source target. |
| `source_selection` | `object` | Yes | Structured source selection details returned by the tool. |

## Full schemas

```json title="input-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "runtime_target_kind": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "main_branch",
            "environment",
            "preview_branch"
          ],
          "description": "Provide the runtime target kind."
        },
        {
          "type": "null",
          "description": "Provide the runtime target kind."
        }
      ],
      "description": "Provide the runtime target kind."
    },
    "target_environment_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "Provide the target environment id."
        },
        {
          "type": "null",
          "description": "Provide the target environment id."
        }
      ],
      "description": "Provide the target environment id."
    },
    "target_branch_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "Provide the target branch id."
        },
        {
          "type": "null",
          "description": "Provide the target branch id."
        }
      ],
      "description": "Provide the target branch id."
    },
    "source_target_kind": {
      "type": "string",
      "enum": [
        "project",
        "main_branch",
        "environment",
        "preview_branch"
      ],
      "description": "Provide the source target kind."
    },
    "identity": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Exact definition ID or display name. Omit to browse."
    },
    "kinds": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "agent",
          "prompt",
          "tool",
          "task",
          "workflow",
          "resource",
          "skill",
          "eval",
          "schedule",
          "webhook"
        ],
        "description": "One kind item supplied to the tool."
      },
      "minItems": 1,
      "maxItems": 10,
      "description": "Source definition kinds to inspect. Display names do not establish kind. When the kind is unknown, omit this filter to inspect all source kinds; coverage reports access and completeness for each kind."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "description": "Maximum number of results to return."
    },
    "cursor": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Opaque pagination cursor returned by a previous response."
    },
    "project_reference": {
      "type": "string",
      "minLength": 1,
      "description": "Project identifier or slug that scopes the tool call."
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Arguments for the search_project_definitions tool."
}
```

```json title="output-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "agent",
              "prompt",
              "tool",
              "task",
              "workflow",
              "resource",
              "skill",
              "eval",
              "schedule",
              "webhook"
            ],
            "description": "The kind returned by the tool."
          },
          "id": {
            "type": "string",
            "minLength": 1,
            "description": "Unique identifier for the returned record."
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "description": "Human-readable name for the returned record."
          },
          "description": {
            "type": "string",
            "maxLength": 240,
            "description": "Human-readable description returned by the tool."
          },
          "source_path": {
            "type": "string",
            "minLength": 1,
            "description": "The source path returned by the tool."
          },
          "reader": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "operation": {
                    "type": "string",
                    "description": "The operation returned by the tool."
                  },
                  "identity_parameter": {
                    "type": "string",
                    "description": "The identity parameter returned by the tool."
                  },
                  "identity": {
                    "type": "string",
                    "description": "The identity returned by the tool."
                  }
                },
                "required": [
                  "operation",
                  "identity_parameter",
                  "identity"
                ],
                "additionalProperties": false,
                "description": "Structured reader details returned by the tool."
              },
              {
                "type": "null",
                "description": "The reader returned by the tool."
              }
            ],
            "description": "The reader returned by the tool."
          },
          "reader_unavailable_reason": {
            "type": "string",
            "description": "The reader unavailable reason returned by the tool."
          }
        },
        "required": [
          "kind",
          "id",
          "name",
          "source_path",
          "reader"
        ],
        "additionalProperties": false,
        "description": "One data item returned by the tool."
      },
      "maxItems": 50,
      "description": "Saved project source definitions, not executable tools. A display name does not establish its kind; read a definition with its reader operation and identity."
    },
    "total_matches": {
      "type": "integer",
      "minimum": 0,
      "description": "Total number of matches found by the tool."
    },
    "page_info": {
      "type": "object",
      "properties": {
        "self": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor that refers to the current page."
        },
        "first": {
          "type": "null",
          "description": "The first returned by the tool."
        },
        "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."
    },
    "resolution": {
      "type": "string",
      "enum": [
        "listed",
        "found",
        "ambiguous",
        "not_found",
        "incomplete"
      ],
      "description": "Lookup result for the requested kinds at the selected source target. not_found means no matching identity in those kinds only when their coverage is complete; it does not rule out other kinds or targets."
    },
    "suggested_query": {
      "type": "object",
      "properties": {
        "project_reference": {
          "type": "string",
          "minLength": 1,
          "description": "Project identifier or slug associated with this result."
        },
        "identity": {
          "type": "string",
          "minLength": 1,
          "description": "The identity returned by the tool."
        },
        "source_target_kind": {
          "type": "string",
          "enum": [
            "project",
            "main_branch",
            "environment",
            "preview_branch"
          ],
          "description": "The source target kind returned by the tool."
        },
        "target_environment_id": {
          "type": "string",
          "minLength": 1,
          "description": "The target environment id returned by the tool."
        },
        "target_branch_id": {
          "type": "string",
          "minLength": 1,
          "description": "The target branch id returned by the tool."
        }
      },
      "required": [
        "project_reference",
        "identity",
        "source_target_kind"
      ],
      "additionalProperties": false,
      "description": "For a complete miss with an explicit kind filter, retry this exact identity and source target without kinds. This does not imply a match exists in another kind."
    },
    "kind_filter_miss": {
      "type": "object",
      "properties": {
        "requested_kinds": {
          "type": "array",
          "items": {
            "$ref": "#/properties/data/items/properties/kind",
            "description": "One requested kind item returned by the tool."
          },
          "minItems": 1,
          "description": "List of requested kinds returned by the tool."
        }
      },
      "required": [
        "requested_kinds"
      ],
      "additionalProperties": false,
      "description": "Present when the identity was absent from the requested kinds but exists in another kind. data, coverage, resolution and page_info then describe the unfiltered lookup; use each match kind and reader, not the requested kinds. To continue, re-send the same query (with or without kinds) and page_info.next; the widening is re-applied."
    },
    "coverage": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "kind": {
            "$ref": "#/properties/data/items/properties/kind",
            "description": "The kind returned by the tool."
          },
          "status": {
            "type": "string",
            "enum": [
              "complete",
              "incomplete",
              "not_authorized"
            ],
            "description": "Lifecycle status for the returned record."
          },
          "diagnostic_count": {
            "type": "integer",
            "minimum": 0,
            "description": "The diagnostic count returned by the tool."
          },
          "diagnostics": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "source_file_diagnostic",
                    "source_agent_discovery_error",
                    "source_trigger_discovery_error"
                  ],
                  "description": "The kind returned by the tool."
                },
                "source_kind": {
                  "type": "string",
                  "enum": [
                    "agent",
                    "prompt",
                    "tool",
                    "task",
                    "workflow",
                    "resource",
                    "skill",
                    "eval",
                    "schedule",
                    "webhook"
                  ],
                  "description": "The source kind returned by the tool."
                },
                "source_path": {
                  "type": "string",
                  "minLength": 1,
                  "description": "The source path returned by the tool."
                },
                "source_id": {
                  "type": "string",
                  "minLength": 1,
                  "description": "The source id returned by the tool."
                },
                "code": {
                  "type": "string",
                  "enum": [
                    "parse_error",
                    "invalid_definition",
                    "dynamic_definition",
                    "duplicate_source_id",
                    "unsupported_target",
                    "manual_conflict"
                  ],
                  "description": "The code returned by the tool."
                },
                "message": {
                  "type": "string",
                  "minLength": 1,
                  "description": "The message returned by the tool."
                },
                "details": {
                  "type": "object",
                  "additionalProperties": {
                    "description": "Additional structured values returned by the tool."
                  },
                  "description": "Structured details details returned by the tool."
                }
              },
              "required": [
                "kind",
                "source_kind",
                "source_path",
                "code",
                "message"
              ],
              "additionalProperties": false,
              "description": "One diagnostic item returned by the tool."
            },
            "maxItems": 5,
            "description": "List of diagnostics returned by the tool."
          }
        },
        "required": [
          "kind",
          "status",
          "diagnostic_count",
          "diagnostics"
        ],
        "additionalProperties": false,
        "description": "One coverage item returned by the tool."
      },
      "description": "Discovery coverage for the requested kinds at the selected source target."
    },
    "source_selection": {
      "type": "object",
      "properties": {
        "project_id": {
          "type": "string",
          "minLength": 1,
          "description": "Resolved project ID for this authorized lookup."
        },
        "source_target_kind": {
          "$ref": "#/properties/suggested_query/properties/source_target_kind",
          "description": "The source target kind returned by the tool."
        },
        "target_environment_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "The target environment id returned by the tool."
        },
        "target_branch_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "The target branch id returned by the tool."
        }
      },
      "required": [
        "project_id",
        "source_target_kind",
        "target_environment_id",
        "target_branch_id"
      ],
      "additionalProperties": false,
      "description": "Structured source selection details returned by the tool."
    }
  },
  "required": [
    "data",
    "total_matches",
    "page_info",
    "resolution",
    "coverage",
    "source_selection"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Structured result returned by the search_project_definitions tool."
}
```

<details>
  <summary>Try this tool</summary>

  Replace sample arguments with values for your project or connected account. Calls run only when you select Run tool.

  MCP tool call

  Call `veryfront__search_project_definitions` against the Veryfront MCP endpoint.

  Bearer token or API key

  Arguments (JSON)

  Run tool

  Output JSON

  <pre />
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.