Skip to main content
Glama
Sign In
weeek-mcp

weeek-mcp

Official
by YOLKINS
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

List Weeek boards for a project

weeek_list_boards
Read-onlyIdempotent

Discover all boards in a Weeek project by providing its project ID. Returns board IDs, names, and privacy status for use in board column queries.

Instructions

PRIMARY tool for board discovery within a project: returns every Weeek board in the given project ({id, name, projectId, isPrivate} per board). project_id is required; pagination is not exposed by this endpoint. Use when the agent needs a board_id to feed into weeek_list_board_columns, or to surface the board picker for a project.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "project_id": "<project_id>"
    },
    "name": "weeek_list_boards"
  }
}

Input Schema

NameRequiredDescriptionDefault
project_idYesWeeek project identifier (from weeek_list_projects or the Weeek UI). Required — `/tm/boards` returns HTTP 422 without it.

Output Schema

NameRequiredDescriptionDefault
boardsYesBoards belonging to the requested project
truncatedYesTrue if the response was clipped by the server's MAX_RESPONSE_CHARS gate. Re-issue with a narrower project_id or raise MAX_RESPONSE_CHARS in the server env to receive the full payload.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint false. The description adds that the endpoint returns all boards, lists the per-board fields, and explicitly states pagination is not exposed—useful behavior beyond the annotations.

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

Conciseness5/5

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

Two sentences, front-loaded with purpose, includes essential usage and limitation info without redundancy.

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

Completeness5/5

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

For a single-parameter list tool with a rich schema and annotations, the description covers discovery, usage, return shape, and limitations, making it nearly self-sufficient.

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 covers project_id 100% with origin and HTTP 422 error detail. The description only restates that project_id is required, adding no new semantic information, so baseline 3 applies.

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?

Description explicitly states it returns every Weeek board in the given project, lists the fields, and positions itself as the PRIMARY tool for board discovery, distinguishing it from siblings like weeek_list_board_columns.

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

Usage Guidelines5/5

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

Provides explicit usage direction: use when a board_id is needed to feed into weeek_list_board_columns or to surface the board picker. Also notes project_id is required and pagination is not exposed, giving context on limitations.

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