Skip to main content
Glama

get_board

Read-onlyIdempotent

Retrieve a saved OpenProject board or query by its board ID to view project data and task lists.

Instructions

Get a saved OpenProject board/query by id.

Input Schema

NameRequiredDescriptionDefault
board_idYes

Output Schema

NameRequiredDescriptionDefault
idYes
nameYes
hiddenYes
publicYes
columnsYes
filtersYes
projectYes
sort_byYes
starredYes
group_byYes
can_deleteYes
can_updateYes
created_atYes
project_idYes
timestampsYes
updated_atYes
show_hierarchiesYes
timeline_visibleYes
highlighting_modeYes
include_subprojectsYes
timeline_zoom_levelYes
highlighted_attributesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.4.4
  2. Removedv0.4.0
  3. Changed3 schema fields changedv0.3.7
    • addedInput schema / additionalProperties
      Added value: +false
    • removedOutput schema / properties / url
      Removed value: -{
      -  "title": "Url",
      -  "type": "string"
      -}
    • changedOutput schema / required
      Previous value: -[
      -  "id",
      -  "name",
      -  "project_id",
      -  "project",
      -  "public",
      -  "hidden",
      -  "starred",
      -  "include_subprojects",
      -  "show_hierarchies",
      -  "timeline_visible",
      -  "timeline_zoom_level",
      -  "highlighting_mode",
      -  "group_by",
      -  "columns",
      -  "sort_by",
      -  "highlighted_attributes",
      -  "timestamps",
      -  "filters",
      -  "created_at",
      -  "updated_at",
      -  "can_update",
      -  "can_delete",
      -  "url"
      -]New value: +[
      +  "id",
      +  "name",
      +  "project_id",
      +  "project",
      +  "public",
      +  "hidden",
      +  "starred",
      +  "include_subprojects",
      +  "show_hierarchies",
      +  "timeline_visible",
      +  "timeline_zoom_level",
      +  "highlighting_mode",
      +  "group_by",
      +  "columns",
      +  "sort_by",
      +  "highlighted_attributes",
      +  "timestamps",
      +  "filters",
      +  "created_at",
      +  "updated_at",
      +  "can_update",
      +  "can_delete"
      +]
  4. Addedv0.3.3
  5. Removedv0.3.0
  6. First observedv0.2.2

TDQS

C2.8/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is covered. The description adds only that the object is 'saved' and looked up by id; it says nothing about not-found behavior, permission requirements, or whether the returned object includes work packages or query state.

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?

A single short sentence with no filler, and the retrieval key is front-loaded. It is efficient, though the brevity contributes to the missing sibling differentiation and parameter detail rather than reflecting a deliberate minimal specification.

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

Completeness3/5

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

An output schema exists, so return-value explanation is not required, and the annotations cover safety and world assumptions. However, with a schema that gives no parameter description and multiple overlapping siblings, the definition is only minimally sufficient to call the tool correctly and does not resolve the board vs. query vs. grid ambiguity.

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

Parameters2/5

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

Schema description coverage is 0% for the single required parameter board_id, so the description must carry the burden. It only says 'by id', without explaining the id format, where to obtain it (e.g., list_boards), or whether it accepts query or board identifiers. That is closer to restating the parameter name than adding meaning.

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

Purpose4/5

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

The description gives a specific verb ('Get') and resource ('saved OpenProject board/query') plus the lookup key ('by id'), so an agent can tell this is a single-item fetch rather than a list. It does not distinguish the tool from near-siblings like get_grid, get_view, or execute_query, and 'board/query' blurs whether this returns a board or a query object.

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

Usage Guidelines2/5

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

There is no guidance on when to use this versus list_boards, list_grids, get_view, or execute_query, nor any prerequisite about where a board_id comes from. The phrase 'saved ... by id' implies a retrieval scenario but gives no explicit conditions or alternatives.

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

Deploy Server

Other Tools