get_board_cycle
Get boards with their budgets, budget change history, and associated cycles.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
openOnly | bool | No | true | When true, only returns open (non-closed) cycles. |
Returns
A list ofBoardDto objects, each containing:
boardId,boardName— board identityurl— direct link to the board in the Ekso web appbudgetHours— total budget in hoursbudgetChanges— history of budget adjustments with reason, user, date, and deltacycles— list of cycles with ID, name, dates, budget, and closed status
get_board_reason_codes
Get the list of budget reason change codes used when adjusting board budgets.| Property | |
|---|---|
| Read-only | Yes |
Parameters
None.Returns
A list ofConfigBudgetReason objects with ID and name.
get_board_cycle_item_list
Get items within a specific cycle, with optional limit and description inclusion.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cycleId | string | Yes | — | Cycle ID to query items from. |
limit | int | No | 25 | Maximum number of items to return. |
includeDescription | bool | No | false | Include item descriptions in the response. |
Returns
A list ofCycleItemDto objects sorted by key, each containing: key, name, url, description (if requested), container, board, cycle, status, work estimate, time logged, resource type, and resource name. The url field links directly to each item in the Ekso web app.
create_board
Create a new planning board for organizing work into cycles.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Board name. |
container | string[] | No | Container IDs to associate. Use get_containers. |
resource | string[] | No | Resource (user) IDs to associate. Use get_user_list. |
budgetHours | int | No | Initial budget in hours. Uses the first available budget reason code. |
Returns
ABoardDto with the created board’s details.
update_board
Update board settings including name, containers, resources, and budget. Only provided fields are updated.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
boardId | string | Yes | Board ID. |
name | string | No | New board name. |
containerIds | string[] | No | Replace container associations. |
resourceIds | string[] | No | Replace resource associations. |
budgetChangeHours | int | No | Budget change amount in hours. Requires budgetChangeReasonId. |
budgetChangeReasonId | string | No | Reason code for the budget change. Use get_board_reason_codes. |
Returns
ABoardDto with the updated board details and current cycles.
delete_board
Delete a board. Requires Manage permission on the board.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
boardId | string | Yes | Board ID. Use get_board_cycle. |
Returns
A confirmation message with the deleted board’s name.get_portfolio_summary
Get a portfolio-level summary across all boards the user can view. Returns aggregate health, budget, items, cycles, and financials, plus a per-board breakdown including budget consumption, status distribution, and projected/logged revenue and cost. Use this tool to answer questions about overall portfolio health, identify at-risk boards, or compare financial performance across boards.| Property | |
|---|---|
| Read-only | Yes |
Parameters
None.Returns
APortfolioResult object containing:
aggregate— totals across all boards:totalBudgetHours,totalPlannedHours,totalItems,totalActiveCycles,projectedRevenue,loggedRevenue,projectedCost,loggedCostboards— list of per-board summaries, each with:boardId,budgetHours,plannedHours,itemCount,activeCycleCount,projectedRevenue,loggedRevenue,projectedCost,loggedCost, andstatusCounts(working, blocked, open, closed)
plannedHours / budgetHours >= 85%.
get_board_capacity
Get capacity and financial data for a specific board and cycle: per-resource planned hours, capacity hours, utilization percentage, and projected cost and revenue.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
boardId | string | Yes | Board ID. Use get_board_cycle. |
cycleId | string | Yes | Cycle ID. Use get_board_cycle. |
Returns
ACapacityResult object containing:
boardBudgetHours,cycleBudgetHours,cyclePlannedHours— budget contextresources— per-resource breakdown withuserName,totalCapacityHours,plannedHours,availableHours,utilizationPercent,plannedCost,plannedRevenueaggregate— totals:totalCapacityHours,totalPlannedHours,totalAvailableHours,utilizationPercent,totalPlannedCost,totalPlannedRevenue,grossMarginPercent,totalLoggedCost,totalLoggedRevenue
get_board_resource_utilization
Get a resource-by-cycle utilization heatmap for a board. Shows each resource’s planned hours, capacity hours, and utilization percentage across all open cycles. Use this to identify overloaded or underutilized resources.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
boardId | string | Yes | Board ID. Use get_board_cycle. |
Returns
AHeatmapResult with a list of resources, each containing:
userId,userName,resourceType(User or JobRole)cycles— list of cycle entries withcycleId,cycleName,plannedHours,capacityHours,utilizationPercent
get_board_status_summary
Get item counts by workflow status (working, blocked, open, closed) for a specific board.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
boardId | string | Yes | Board ID. Use get_board_cycle. |
Returns
ABoardStatusSummary object containing:
boardId— the board identifieritemCount— total items on the boardstatusCounts— breakdown by workflow status:working,blocked,open,closed