Teamwork

Official

Overview Schema Source Related Servers Discussions Admin

twprojects-list_project_budgets

Read-only

List project budgets filtered by project or status, with pagination and field selection. Get counts or specific budget details for budgeted projects only.

Instructions

Lists top-level project budgets. Filters: project_ids, status.Returns only budgeted projects (diff with twprojects-list_projects for budgetless).Filter server-side via project_ids when known. 1-based page pagination (pageOffset = page - 1)

Input Schema

TableJSON Schema

Name	Required	Description
`page`	No	Page number for pagination of results (1-based).
`limit`	No	Maximum number of budgets to return. Only applies alongside cursor; ignored when paging with page/page_size.
`cursor`	No	Opaque cursor from a previous response, for cursor pagination. This is not an offset or a page number — never construct one. Setting it makes the endpoint ignore page and page_size. To walk pages, use page instead.
`fields`	No	The attributes to return for each project budget, from the listed names.
`status`	No	Filter budgets by status.
`verbose`	No	If false, returns id + name only — useful when scanning many results.
`page_size`	No	Number of results per page for pagination (1-500).
`count_only`	No	If true, return only {"count": N}: the exact number of matching project budgets, no rows — use for "how many". Ignores page, page_size, verbose, fields.
`project_ids`	No	Filter budgets by project.

Output Schema

TableJSON Schema

Name	Required	Description
`meta`	No
`count`	No	Exact number of matches across every page. Returned instead of the rows when count_only.
`budgets`	No
`included`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed24 schema fields changedv1.39.3Sep 9, 2026

removedInput schema / properties / count_only / anyOf

Removed value: -[
-  {
-    "type": "boolean"
-  },
-  {
-    "type": "null"
-  }
-]

addedInput schema / properties / count_only / type
```
Added value: +"boolean"
```

removedInput schema / properties / cursor / anyOf

Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

addedInput schema / properties / cursor / type
```
Added value: +"string"
```

removedInput schema / properties / fields / anyOf

Removed value: -[
-  {
-    "items": {
-      "enum": [
-        "id",
-        "projectId",
-        "type",
-        "status",
-        "capacity",
-        "capacityUsed",
-        "originatorBudgetId",
-        "isRepeating",
-        "repeatPeriod",
-        "repeatUnit",
-        "repeatsRemaining",
-        "sequenceNumber",
-        "startDateTime",
-        "endDateTime",
-        "currencyCode",
-        "timelogType",
-        "expenseType",
-        "defaultRate",
-        "notificationIds",
-        "createdByUserId",
-        "dateCreated",
-        "updatedBy",
-        "dateUpdated",
-        "completedByUserId",
-        "dateCompleted",
-        "deletedByUserId",
-        "dateDeleted"
-      ],
-      "type": "string"
-    },
-    "type": "array"
-  },
-  {
-    "type": "null"
-  }
-]

addedInput schema / properties / fields / items

Added value: +{
+  "enum": [
+    "id",
+    "projectId",
+    "type",
+    "status",
+    "capacity",
+    "capacityUsed",
+    "originatorBudgetId",
+    "isRepeating",
+    "repeatPeriod",
+    "repeatUnit",
+    "repeatsRemaining",
+    "sequenceNumber",
+    "startDateTime",
+    "endDateTime",
+    "currencyCode",
+    "timelogType",
+    "expenseType",
+    "defaultRate",
+    "notificationIds",
+    "createdByUserId",
+    "dateCreated",
+    "updatedBy",
+    "dateUpdated",
+    "completedByUserId",
+    "dateCompleted",
+    "deletedByUserId",
+    "dateDeleted"
+  ],
+  "type": "string"
+}

addedInput schema / properties / fields / type
```
Added value: +"array"
```

removedInput schema / properties / limit / anyOf

Removed value: -[
-  {
-    "type": "integer"
-  },
-  {
-    "type": "null"
-  }
-]

addedInput schema / properties / limit / type
```
Added value: +"integer"
```

removedInput schema / properties / page / anyOf

Removed value: -[
-  {
-    "minimum": 1,
-    "type": "integer"
-  },
-  {
-    "type": "null"
-  }
-]

addedInput schema / properties / page / minimum
```
Added value: +1
```
addedInput schema / properties / page / type
```
Added value: +"integer"
```

removedInput schema / properties / page_size / anyOf

Removed value: -[
-  {
-    "maximum": 500,
-    "minimum": 1,
-    "type": "integer"
-  },
-  {
-    "type": "null"
-  }
-]

addedInput schema / properties / page_size / maximum
```
Added value: +500
```
addedInput schema / properties / page_size / minimum
```
Added value: +1
```
addedInput schema / properties / page_size / type
```
Added value: +"integer"
```

removedInput schema / properties / project_ids / anyOf

Removed value: -[
-  {
-    "items": {
-      "type": "integer"
-    },
-    "type": "array"
-  },
-  {
-    "type": "null"
-  }
-]

addedInput schema / properties / project_ids / items
```
Added value: +{
+  "type": "integer"
+}
```
addedInput schema / properties / project_ids / type
```
Added value: +"array"
```

removedInput schema / properties / status / anyOf

Removed value: -[
-  {
-    "enum": [
-      "UPCOMING",
-      "ACTIVE",
-      "COMPLETED"
-    ],
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

addedInput schema / properties / status / enum

Added value: +[
+  "UPCOMING",
+  "ACTIVE",
+  "COMPLETED"
+]

addedInput schema / properties / status / type
```
Added value: +"string"
```

removedInput schema / properties / verbose / anyOf

Removed value: -[
-  {
-    "type": "boolean"
-  },
-  {
-    "type": "null"
-  }
-]

addedInput schema / properties / verbose / type
```
Added value: +"boolean"
```

Changed5 schema fields changedv1.31.0Aug 19, 2026

addedInput schema / properties / count_only

Added value: +{
+  "anyOf": [
+    {
+      "type": "boolean"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": false,
+  "description": "If true, return only {\"count\": N}: the exact number of matching project budgets, no rows — use for \"how many\". Ignores page, page_size, verbose, fields."
+}

addedOutput schema / properties / count

Added value: +{
+  "description": "Exact number of matches across every page. Returned instead of the rows when count_only.",
+  "type": "integer"
+}

changedOutput schema / properties / meta / properties / page / properties / count / type
```
Previous value: -"integer"New value: +[
+  "null",
+  "integer"
+]
```
removedOutput schema / properties / meta / properties / page / properties / pageOffset
```
Removed value: -{
-  "type": "integer"
-}
```
removedOutput schema / properties / meta / properties / page / properties / pageSize
```
Removed value: -{
-  "type": "integer"
-}
```

Changed2 schema fields changedv1.27.2Aug 10, 2026

addedInput schema / properties / fields

Added value: +{
+  "anyOf": [
+    {
+      "items": {
+        "enum": [
+          "id",
+          "projectId",
+          "type",
+          "status",
+          "capacity",
+          "capacityUsed",
+          "originatorBudgetId",
+          "isRepeating",
+          "repeatPeriod",
+          "repeatUnit",
+          "repeatsRemaining",
+          "sequenceNumber",
+          "startDateTime",
+          "endDateTime",
+          "currencyCode",
+          "timelogType",
+          "expenseType",
+          "defaultRate",
+          "notificationIds",
+          "createdByUserId",
+          "dateCreated",
+          "updatedBy",
+          "dateUpdated",
+          "completedByUserId",
+          "dateCompleted",
+          "deletedByUserId",
+          "dateDeleted"
+        ],
+        "type": "string"
+      },
+      "type": "array"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "The attributes to return for each project budget, from the listed names."
+}

changedInput schema / properties / status / anyOf

Previous value: -[
-  {
-    "enum": [
-      "upcoming",
-      "active",
-      "complete"
-    ],
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "enum": [
+      "UPCOMING",
+      "ACTIVE",
+      "COMPLETED"
+    ],
+    "type": "string"
+  },
+  {
+    "type": "null"
+  }
+]

Changed7 schema fields changedv1.26.5Aug 5, 2026

changedInput schema / properties / cursor / description

Previous value: -"Cursor for fetching the next page of results."New value: +"Opaque cursor from a previous response, for cursor pagination. This is not an offset or a page number — never construct one. Setting it makes the endpoint ignore page and page_size. To walk pages, use page instead."

changedInput schema / properties / limit / description

Previous value: -"Maximum number of budgets to return."New value: +"Maximum number of budgets to return. Only applies alongside cursor; ignored when paging with page/page_size."

addedInput schema / properties / page

Added value: +{
+  "anyOf": [
+    {
+      "minimum": 1,
+      "type": "integer"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "Page number for pagination of results (1-based)."
+}

changedInput schema / properties / page_size / anyOf

Previous value: -[
-  {
-    "type": "integer"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "maximum": 500,
+    "minimum": 1,
+    "type": "integer"
+  },
+  {
+    "type": "null"
+  }
+]

changedInput schema / properties / page_size / description

Previous value: -"Number of results per page for pagination."New value: +"Number of results per page for pagination (1-500)."

addedOutput schema / properties / budgets / items / properties / updatedBy
```
Added value: +{
+  "type": [
+    "null",
+    "integer"
+  ]
+}
```
removedOutput schema / properties / budgets / items / properties / updatedUserId
```
Removed value: -{
-  "type": [
-    "null",
-    "integer"
-  ]
-}
```

Changed3 schema fields changedv1.20.3May 18, 2026

changedInput schema / properties / project_ids / description

Previous value: -"A list of project IDs to filter budgets by project."New value: +"Filter budgets by project."

changedInput schema / properties / status / description

Previous value: -"Filter budgets by status. Allowed values: upcoming, active, complete."New value: +"Filter budgets by status."

changedInput schema / properties / verbose / description

Previous value: -"If true (default), the response includes full entity details. If false, only a minimal subset of fields (typically an id and a name/title) is returned to reduce response size — useful when scanning many results to pick an id before fetching the full entity."New value: +"If false, returns id + name only — useful when scanning many results."

Changed10 schema fields changedv1.20.1May 15, 2026

addedInput schema / properties / verbose

Added value: +{
+  "anyOf": [
+    {
+      "type": "boolean"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": true,
+  "description": "If true (default), the response includes full entity details. If false, only a minimal subset of fields (typically an id and a name/title) is returned to reduce response size — useful when scanning many results to pick an id before fetching the full entity."
+}

removedOutput schema / additionalProperties
```
Removed value: -false
```
removedOutput schema / properties / budgets / items / additionalProperties
```
Removed value: -false
```

removedOutput schema / properties / budgets / items / required

Removed value: -[
-  "id",
-  "projectId",
-  "type",
-  "status",
-  "capacity",
-  "capacityUsed",
-  "originatorBudgetId",
-  "isRepeating",
-  "repeatPeriod",
-  "repeatUnit",
-  "repeatsRemaining",
-  "sequenceNumber",
-  "startDateTime",
-  "endDateTime",
-  "currencyCode",
-  "timelogType",
-  "expenseType",
-  "defaultRate",
-  "notificationIds",
-  "createdByUserId",
-  "dateCreated",
-  "updatedUserId",
-  "dateUpdated",
-  "completedByUserId",
-  "dateCompleted",
-  "deletedByUserId",
-  "dateDeleted"
-]

removedOutput schema / properties / included / additionalProperties

Removed value: -{
-  "items": {
-    "maximum": 255,
-    "minimum": 0,
-    "type": "integer"
-  },
-  "type": [
-    "null",
-    "array"
-  ]
-}

removedOutput schema / properties / meta / additionalProperties
```
Removed value: -false
```
removedOutput schema / properties / meta / properties / page / additionalProperties
```
Removed value: -false
```

removedOutput schema / properties / meta / properties / page / required

Removed value: -[
-  "pageOffset",
-  "pageSize",
-  "count",
-  "hasMore"
-]

removedOutput schema / properties / meta / required
```
Removed value: -[
-  "page"
-]
```

removedOutput schema / required

Removed value: -[
-  "budgets",
-  "meta",
-  "included"
-]

Addedv1.18.3May 12, 2026
Removedv1.18.2May 11, 2026

Changed1 schema field changedv1.18.1May 7, 2026

changedInput schema / properties / page_size / description

Previous value: -"Number of budgets to return per page."New value: +"Number of results per page for pagination."

Addedv1.17.2May 4, 2026

TDQS

A4.1/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already carry the safety profile (readOnlyHint=true, destructiveHint=false), so the description's burden is lighter. It adds genuine behavioral context beyond the annotations: the selection behavior ('Returns only budgeted projects'), the efficiency recommendation for server-side filtering, and a non-obvious pagination detail ('1-based page pagination (pageOffset = page - 1)'). This pagination clarification is exactly the kind of trait an agent needs to call the tool correctly.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Four sentences pack the essential information: purpose, filters, sibling differentiation, and pagination semantics, with the core function front-loaded first. No filler. It loses a point only for minor formatting defects (missing spaces: 'status.Returns' and 'budgetless).Filter') that slightly reduce readability.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (9 optional parameters, output schema present, annotations present), the description covers the key decision points: what is returned, the filter options, the sibling distinction, and pagination behavior. The one notable gap is not explaining how 'top-level' budgets relate to the closely named twprojects-list_tasklist_budgets sibling, which could leave an agent uncertain about which list tool to invoke in a given context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents all 9 parameters thoroughly, including cursor caveats and count_only semantics. The description reinforces that project_ids and status act as filters and hints at pagination mechanics, but adds little beyond what the schema states. Baseline 3 is appropriate since the structured data carries the parameter burden.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Opens with a specific verb+resource statement: 'Lists top-level project budgets.' The qualifier 'top-level' usefully distinguishes this from tasklist-level budget tools among the siblings, and it explicitly names twprojects-list_projects as the sibling that covers budgetless projects. An agent can tell what this tool is for and what it is not for without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides explicit routing guidance: 'Returns only budgeted projects (diff with twprojects-list_projects for budgetless)' names the alternative and the selection condition, and 'Filter server-side via project_ids when known' advises on when to pass filters rather than post-filtering. It stops short of a 5 because it does not address the near-twin sibling twprojects-list_tasklist_budgets or state when to prefer count_only, but the core when-to-use guidance is explicit.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server