> ## 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.

# List project resources

> List the project resources defined in the source of a project, a branch or an environment to find one to read or edit; returns every project resource with the source files that could not be read.

`veryfront__list_project_resources`

Requires project.resources.read.

## 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 |
| - | - | - | - |
| `project_reference` | `string` | No | Project ID or slug |
| `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"`. |

## 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__list_project_resources",
    "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. |
| `page_info` | `object` | Yes | Every project resource is one page: next is always null. |
| `diagnostics` | `object[]` | Yes | List of diagnostics associated with this record. |

## Full schemas

```json title="input-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    },
    "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."
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Arguments for the list_project_resources tool."
}
```

```json title="output-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the returned record."
          },
          "pattern": {
            "type": "string"
          },
          "description": {
            "type": "string",
            "description": "Human-readable description returned by the tool."
          },
          "title": {
            "type": [
              "string",
              "null"
            ],
            "description": "Short human-readable title returned by the tool."
          },
          "source_path": {
            "type": "string"
          },
          "edit_mode": {
            "type": "string",
            "enum": [
              "structured",
              "source_only"
            ]
          }
        },
        "required": [
          "id",
          "pattern",
          "description",
          "source_path",
          "edit_mode"
        ],
        "additionalProperties": false
      },
      "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": "null",
          "description": "The first associated with this record."
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor for the next page."
        },
        "prev": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor for the previous page."
        }
      },
      "required": [
        "self",
        "first",
        "next",
        "prev"
      ],
      "additionalProperties": false,
      "description": "Every project resource is one page: next is always null."
    },
    "diagnostics": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "const": "source_file_diagnostic",
            "description": "The kind associated with this record."
          },
          "source_kind": {
            "type": "string",
            "enum": [
              "agent",
              "prompt",
              "tool",
              "task",
              "workflow",
              "resource",
              "skill",
              "eval",
              "schedule",
              "webhook"
            ],
            "description": "The source kind associated with this record."
          },
          "source_path": {
            "type": "string",
            "minLength": 1,
            "description": "The source path associated with this record."
          },
          "source_id": {
            "type": "string",
            "minLength": 1,
            "description": "The source id associated with this record."
          },
          "code": {
            "type": "string",
            "enum": [
              "parse_error",
              "invalid_definition",
              "dynamic_definition",
              "duplicate_source_id",
              "unsupported_target",
              "manual_conflict"
            ],
            "description": "The code associated with this record."
          },
          "message": {
            "type": "string",
            "minLength": 1,
            "description": "The message associated with this record."
          }
        },
        "required": [
          "kind",
          "source_kind",
          "source_path",
          "code",
          "message"
        ],
        "additionalProperties": false,
        "description": "One diagnostic item associated with this record."
      },
      "description": "List of diagnostics associated with this record."
    }
  },
  "required": [
    "data",
    "page_info",
    "diagnostics"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the list_project_resources tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
```

<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__list_project_resources` 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.