Get budget - Veryfront

veryfront__get_budget

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
`budget_id`	`string`	Yes	Budget ID. A budget you cannot manage is masked as missing and fails with resource-not-found (404). Format: `uuid`.

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__get_budget",
    "arguments": {
      "budget_id": "00000000-0000-4000-8000-000000000000"
    }
  }
}

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
`id`	`string`	Yes	Unique identifier for the returned record. Format: `uuid`.
`scope`	`object`	Yes	Structured scope details returned by the tool.
`monthly_limit_usd`	`number`	Yes	The monthly AI spend limit, in USD
`monthly_limit_credits`	`number`	Yes	The same limit in credits, the unit spend is counted in
`status`	`object`	Yes	Lifecycle status for the returned record.
`created_at`	`string`	Yes	Creation timestamp in ISO 8601 format.
`updated_at`	`string`	Yes	Last update timestamp in ISO 8601 format.

Full schemas

{
  "type": "object",
  "properties": {
    "budget_id": {
      "type": "string",
      "format": "uuid",
      "description": "Budget ID. A budget you cannot manage is masked as missing and fails with resource-not-found (404)."
    }
  },
  "required": [
    "budget_id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Arguments for the get_budget tool."
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier for the returned record."
    },
    "scope": {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "enum": [
            "api_key",
            "member",
            "project"
          ],
          "description": "The kind returned by the tool."
        },
        "project_id": {
          "anyOf": [
            {
              "type": "string",
              "format": "uuid",
              "description": "Project identifier associated with this result."
            },
            {
              "type": "null",
              "description": "Project identifier associated with this result."
            }
          ],
          "description": "Project identifier associated with this result."
        },
        "user_id": {
          "anyOf": [
            {
              "type": "string",
              "format": "uuid",
              "description": "The user id returned by the tool."
            },
            {
              "type": "null",
              "description": "The user id returned by the tool."
            }
          ],
          "description": "The user id returned by the tool."
        },
        "api_key_id": {
          "anyOf": [
            {
              "type": "string",
              "format": "uuid",
              "description": "The api key id returned by the tool."
            },
            {
              "type": "null",
              "description": "The api key id returned by the tool."
            }
          ],
          "description": "The api key id returned by the tool."
        }
      },
      "required": [
        "kind",
        "project_id",
        "user_id",
        "api_key_id"
      ],
      "additionalProperties": false,
      "description": "Structured scope details returned by the tool."
    },
    "monthly_limit_usd": {
      "type": "number",
      "description": "The monthly AI spend limit, in USD"
    },
    "monthly_limit_credits": {
      "type": "number",
      "description": "The same limit in credits, the unit spend is counted in"
    },
    "status": {
      "type": "object",
      "properties": {
        "used": {
          "type": "number",
          "description": "The used returned by the tool."
        },
        "remaining": {
          "type": "number",
          "description": "The remaining returned by the tool."
        },
        "resets_at": {
          "type": "string",
          "description": "The resets at returned by the tool."
        }
      },
      "required": [
        "used",
        "remaining",
        "resets_at"
      ],
      "additionalProperties": false,
      "description": "Lifecycle status for the returned record."
    },
    "created_at": {
      "type": "string",
      "description": "Creation timestamp in ISO 8601 format."
    },
    "updated_at": {
      "type": "string",
      "description": "Last update timestamp in ISO 8601 format."
    }
  },
  "required": [
    "id",
    "scope",
    "monthly_limit_usd",
    "monthly_limit_credits",
    "status",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Structured result returned by the get_budget tool."
}