Skip to main content
Glama
yokan-board
by yokan-board

get_board

Retrieve a specific Kanban board by its ID to access and manage its columns and tasks through the Yokan Board API.

Instructions

Retrieves a specific Kanban board by its ID.

Args: board_id (int): The ID of the board to retrieve. auth (AuthContext): The authentication context containing user ID and token.

Returns: yokan_models.Board: The requested Kanban board.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
board_idYes
authYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoUnique identifier for the board.
dataNoJSON object representing the board's structure (columns, tasks, etc.).
nameNoName of the Kanban board.
user_idNoID of the user who owns the board.

Implementation Reference

  • The `get_board` MCP tool implementation in `src/main.py`, which retrieves a Kanban board via the `yokan_client`.
    async def get_board(
        board_id: int,
        auth: AuthContext,
    ) -> yokan_models.Board:
        """Retrieves a specific Kanban board by its ID.
    
        Args:
            board_id (int): The ID of the board to retrieve.
            auth (AuthContext): The authentication context containing user ID and token.
    
        Returns:
            yokan_models.Board: The requested Kanban board.
        """
        return await yokan_client.get_board(board_id=board_id, token=auth.token)
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It states this is a retrieval operation but doesn't mention authentication requirements, rate limits, error conditions, or what happens if the board doesn't exist. The description is minimal beyond stating the basic function.

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?

The description is well-structured with clear sections (Args, Returns) and uses minimal words to convey the core information. However, the 'Args' and 'Returns' sections could be integrated more naturally into the flow rather than appearing as separate documentation blocks.

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?

Given the tool has an output schema (yokan_models.Board) and no annotations, the description adequately covers the basic purpose and parameters but lacks important context about authentication behavior, error handling, and differentiation from sibling tools. It's minimally complete but with significant gaps for a read operation.

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 0%, so the description must compensate. It adds semantic meaning by explaining board_id is 'The ID of the board to retrieve' and auth is 'The authentication context containing user ID and token', which provides context beyond the bare schema. However, it doesn't fully compensate for the coverage gap with details on format constraints or auth requirements.

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?

The description clearly states the specific action ('Retrieves') and resource ('a specific Kanban board by its ID'), distinguishing it from sibling tools like get_boards (plural) and other CRUD operations. It precisely communicates the tool's function without ambiguity.

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?

The description provides no guidance on when to use this tool versus alternatives like get_boards, nor does it mention prerequisites or exclusions. It simply states what the tool does without contextual usage information.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/yokan-board/yokan-board-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server