List tools

http
GET /projects/{project_reference}/tools

List tools. Requires project.agents.read.

Servers

json
[
  {
    "url": "https://api.veryfront.com"
  }
]

Authentication

json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyAuth": []
  }
]
json
{
  "bearerAuth": {
    "type": "http",
    "scheme": "bearer",
    "bearerFormat": "JWT or API Key",
    "description": "Use a JWT bearer token or a Veryfront API key in the `Authorization` header."
  },
  "apiKeyAuth": {
    "type": "apiKey",
    "in": "header",
    "name": "X-API-Key",
    "description": "Alternative API key header for `vf_<prefix>_<secret>` tokens."
  }
}

Parameters

NameLocationRequiredDescription
project_referencepathYesProject ID, slug, or domain whose source-defined tool metadata is returned, not the host executable platform or integration tool catalog. An empty list does not mean the host has no callable tools.
runtime_target_kindqueryNo
target_environment_idqueryNo
target_branch_idqueryNo
source_target_kindqueryNo

Parameter contracts

json
[
  {
    "schema": {
      "type": "string",
      "description": "Project ID, slug, or domain whose source-defined tool metadata is returned, not the host executable platform or integration tool catalog. An empty list does not mean the host has no callable tools."
    },
    "required": true,
    "description": "Project ID, slug, or domain whose source-defined tool metadata is returned, not the host executable platform or integration tool catalog. An empty list does not mean the host has no callable tools.",
    "name": "project_reference",
    "in": "path"
  },
  {
    "schema": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "main_branch",
        "environment",
        "preview_branch",
        null
      ]
    },
    "required": false,
    "name": "runtime_target_kind",
    "in": "query"
  },
  {
    "schema": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "required": false,
    "name": "target_environment_id",
    "in": "query"
  },
  {
    "schema": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "required": false,
    "name": "target_branch_id",
    "in": "query"
  },
  {
    "schema": {
      "type": "string",
      "enum": [
        "project",
        "main_branch",
        "environment",
        "preview_branch"
      ]
    },
    "required": false,
    "name": "source_target_kind",
    "in": "query"
  }
]

Responses

200

Discovered project tools

json
{
  "description": "Discovered project tools",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "description": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "source_path": {
                  "type": "string"
                },
                "edit_mode": {
                  "type": "string",
                  "enum": [
                    "structured",
                    "source_only"
                  ]
                },
                "input_schema": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "additionalProperties": {}
                },
                "output_schema": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "additionalProperties": {}
                }
              },
              "required": [
                "id",
                "name",
                "description",
                "source_path",
                "edit_mode",
                "input_schema",
                "output_schema"
              ]
            }
          },
          "page_info": {
            "$ref": "#/components/schemas/PageInfo"
          },
          "diagnostics": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "source_file_diagnostic",
                    "source_agent_discovery_error",
                    "source_trigger_discovery_error"
                  ]
                },
                "source_kind": {
                  "type": "string",
                  "enum": [
                    "agent",
                    "prompt",
                    "tool",
                    "task",
                    "workflow",
                    "resource",
                    "skill",
                    "eval",
                    "schedule",
                    "webhook"
                  ]
                },
                "source_path": {
                  "type": "string",
                  "minLength": 1
                },
                "source_id": {
                  "type": "string",
                  "minLength": 1
                },
                "code": {
                  "type": "string",
                  "enum": [
                    "parse_error",
                    "invalid_definition",
                    "dynamic_definition",
                    "duplicate_source_id",
                    "unsupported_target",
                    "manual_conflict"
                  ]
                },
                "message": {
                  "type": "string",
                  "minLength": 1
                },
                "details": {
                  "type": "object",
                  "additionalProperties": {}
                }
              },
              "required": [
                "kind",
                "source_kind",
                "source_path",
                "code",
                "message"
              ]
            },
            "description": "Source files that could not be read as tools. REST omits it when there are none."
          }
        },
        "required": [
          "data",
          "page_info"
        ]
      }
    }
  }
}

401

Unauthorized

json
{
  "description": "Unauthorized",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/ToolProblem"
      }
    }
  }
}

403

Forbidden

json
{
  "description": "Forbidden",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/ToolProblem"
      }
    }
  }
}

404

Not found

json
{
  "description": "Not found",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/ToolProblem"
      }
    }
  }
}

Referenced contracts

components/schemas/PageInfo

json
{
  "type": "object",
  "properties": {
    "self": {
      "type": [
        "string",
        "null"
      ],
      "description": "Cursor pointing to the current page"
    },
    "first": {
      "type": "null",
      "description": "First page cursor (always null for cursor-based pagination)"
    },
    "next": {
      "type": [
        "string",
        "null"
      ],
      "description": "Cursor for the next page (null if no more pages)"
    },
    "prev": {
      "type": [
        "string",
        "null"
      ],
      "description": "Cursor for the previous page (null if on first page)"
    }
  },
  "required": [
    "self",
    "first",
    "next",
    "prev"
  ]
}

components/schemas/ToolProblem

json
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Problem"
    },
    {
      "type": "object",
      "properties": {
        "edit_mode": {
          "type": "string",
          "enum": [
            "structured",
            "source_only"
          ],
          "description": "Edit mode of the tool definition, on a source_only_conflict."
        },
        "source_only_reasons": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Why the tool can only be edited as raw source, on a source_only_conflict."
        },
        "source_path": {
          "type": "string",
          "description": "Source file of the tool definition, on a source_only_conflict."
        }
      }
    }
  ]
}

components/schemas/Problem

json
{
  "type": "object",
  "properties": {
    "cause": {
      "type": "string",
      "enum": [
        "schedule_concurrency_forbidden",
        "schedule_fire_in_progress",
        "schedule_run_limit_reached"
      ],
      "description": "Schedule admission refusal."
    },
    "idempotency": {
      "type": "object",
      "properties": {
        "state": {
          "type": "string",
          "enum": [
            "in_progress",
            "payload_mismatch",
            "outcome_unknown"
          ]
        },
        "operation": {
          "type": "string",
          "minLength": 1
        },
        "retryable": {
          "type": "boolean"
        },
        "retry_after_seconds": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0
        },
        "expires_at": {
          "type": [
            "string",
            "null"
          ]
        },
        "recovery": {
          "type": "object",
          "properties": {
            "available": {
              "type": "boolean"
            },
            "description": {
              "type": "string"
            },
            "resource_url": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "description"
          ]
        }
      },
      "required": [
        "state",
        "operation",
        "retryable",
        "retry_after_seconds",
        "expires_at"
      ],
      "description": "Replay status, retry timing, and recovery lookup."
    },
    "type": {
      "type": "string",
      "description": "URI reference identifying the problem type",
      "example": "https://api.veryfront.com/errors/validation-failed"
    },
    "title": {
      "type": "string",
      "description": "Short human-readable summary of the problem",
      "example": "Validation Failed"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599,
      "description": "HTTP status code",
      "example": 400
    },
    "code": {
      "type": "string",
      "description": "Stable machine-readable error code",
      "example": "RUN_INVALID_INPUT"
    },
    "detail": {
      "type": "string",
      "description": "Human-readable explanation specific to this occurrence",
      "example": "The 'email' field must be a valid email address"
    },
    "instance": {
      "type": "string",
      "description": "URI reference identifying the specific occurrence",
      "example": "/projects/my-project/members"
    },
    "slug": {
      "type": "string",
      "description": "Stable identifier for the problem type",
      "example": "validation-failed"
    },
    "category": {
      "type": "string",
      "enum": [
        "AUTH",
        "RESOURCE",
        "VALIDATION",
        "DATABASE",
        "SUBSCRIPTION",
        "INTEGRATION",
        "INTERNAL"
      ],
      "description": "API error category",
      "example": "VALIDATION"
    },
    "suggestion": {
      "type": "string",
      "description": "Suggested action to resolve the problem",
      "example": "Check the request body and query parameters against the API documentation."
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "description": "Field path that caused the error",
            "example": "email"
          },
          "message": {
            "type": "string",
            "description": "Error message for this field",
            "example": "Invalid email format"
          },
          "code": {
            "type": "string",
            "description": "Error code for this field",
            "example": "INVALID_FORMAT"
          }
        },
        "required": [
          "field",
          "message"
        ]
      },
      "description": "Detailed field-level errors for validation failures"
    }
  },
  "required": [
    "type",
    "title",
    "status"
  ]
}

Operation contract

json
{
  "operationId": "listTools",
  "tags": [
    "agents/Tools/Project tools"
  ],
  "summary": "List tools",
  "description": "List tools. Requires project.agents.read.",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "description": "Project ID, slug, or domain whose source-defined tool metadata is returned, not the host executable platform or integration tool catalog. An empty list does not mean the host has no callable tools."
      },
      "required": true,
      "description": "Project ID, slug, or domain whose source-defined tool metadata is returned, not the host executable platform or integration tool catalog. An empty list does not mean the host has no callable tools.",
      "name": "project_reference",
      "in": "path"
    },
    {
      "schema": {
        "type": [
          "string",
          "null"
        ],
        "enum": [
          "main_branch",
          "environment",
          "preview_branch",
          null
        ]
      },
      "required": false,
      "name": "runtime_target_kind",
      "in": "query"
    },
    {
      "schema": {
        "type": [
          "string",
          "null"
        ],
        "format": "uuid"
      },
      "required": false,
      "name": "target_environment_id",
      "in": "query"
    },
    {
      "schema": {
        "type": [
          "string",
          "null"
        ],
        "format": "uuid"
      },
      "required": false,
      "name": "target_branch_id",
      "in": "query"
    },
    {
      "schema": {
        "type": "string",
        "enum": [
          "project",
          "main_branch",
          "environment",
          "preview_branch"
        ]
      },
      "required": false,
      "name": "source_target_kind",
      "in": "query"
    }
  ],
  "responses": {
    "200": {
      "description": "Discovered project tools",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "description": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "source_path": {
                      "type": "string"
                    },
                    "edit_mode": {
                      "type": "string",
                      "enum": [
                        "structured",
                        "source_only"
                      ]
                    },
                    "input_schema": {
                      "type": [
                        "object",
                        "null"
                      ],
                      "additionalProperties": {}
                    },
                    "output_schema": {
                      "type": [
                        "object",
                        "null"
                      ],
                      "additionalProperties": {}
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "description",
                    "source_path",
                    "edit_mode",
                    "input_schema",
                    "output_schema"
                  ]
                }
              },
              "page_info": {
                "$ref": "#/components/schemas/PageInfo"
              },
              "diagnostics": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "kind": {
                      "type": "string",
                      "enum": [
                        "source_file_diagnostic",
                        "source_agent_discovery_error",
                        "source_trigger_discovery_error"
                      ]
                    },
                    "source_kind": {
                      "type": "string",
                      "enum": [
                        "agent",
                        "prompt",
                        "tool",
                        "task",
                        "workflow",
                        "resource",
                        "skill",
                        "eval",
                        "schedule",
                        "webhook"
                      ]
                    },
                    "source_path": {
                      "type": "string",
                      "minLength": 1
                    },
                    "source_id": {
                      "type": "string",
                      "minLength": 1
                    },
                    "code": {
                      "type": "string",
                      "enum": [
                        "parse_error",
                        "invalid_definition",
                        "dynamic_definition",
                        "duplicate_source_id",
                        "unsupported_target",
                        "manual_conflict"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "minLength": 1
                    },
                    "details": {
                      "type": "object",
                      "additionalProperties": {}
                    }
                  },
                  "required": [
                    "kind",
                    "source_kind",
                    "source_path",
                    "code",
                    "message"
                  ]
                },
                "description": "Source files that could not be read as tools. REST omits it when there are none."
              }
            },
            "required": [
              "data",
              "page_info"
            ]
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ToolProblem"
          }
        }
      }
    },
    "403": {
      "description": "Forbidden",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ToolProblem"
          }
        }
      }
    },
    "404": {
      "description": "Not found",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/ToolProblem"
          }
        }
      }
    }
  },
  "x-documentation-source-tag": "Project tools",
  "x-canonical-documentation": {
    "domain": "agents",
    "resource": "Tools",
    "subgroup": "Project tools",
    "name": "List tools",
    "description": "List tools. Requires project.agents.read.",
    "operationId": "listTools"
  },
  "x-mint": {
    "href": "/cloud/rest/api-reference/agents-tools-project-tools/list-tools"
  }
}