list_boards
Retrieve boards from a Jira project to manage workflows and track progress. Filter by board type, name, or paginate results for efficient project oversight.
Instructions
List boards from a project
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectKeyOrId | Yes | The key or ID of the project | |
| name | No | The name of the boards to return, Must be less than 255 characters. | |
| maxResults | No | The maximum number of results to return, (max: 100) | |
| startAt | No | The starting index of the returned boards | |
| type | No | The type of boards to return |
Implementation Reference
- src/tools/list_boards.ts:40-59 (handler)The main execution function for the 'list_boards' tool. It constructs the Jira REST API URL for boards endpoint with provided parameters and fetches the data using the $jiraJson helper.
export async function listBoards(input: ListBoardsInput) { const url = new URL(`/rest/agile/1.0/board`, env.JIRA_BASE_URL); url.searchParams.set("projectKeyOrId", input.projectKeyOrId); if (input.name) url.searchParams.set("name", input.name); if (input.type) url.searchParams.set("type", input.type); if (input.startAt) url.searchParams.set("startAt", input.startAt.toString()); if (input.maxResults) url.searchParams.set("maxResults", input.maxResults.toString()); const json = await $jiraJson(url.toString()); if (json.isErr()) return err(json.error); return ok(json.value); } - src/tools/list_boards.ts:10-30 (schema)Zod schema defining the input parameters for the list_boards tool, including project key, optional filters like name, maxResults, startAt, and type.
export const listBoardsInputSchema = z.object({ projectKeyOrId: z.string().describe("The key or ID of the project"), name: z .string() .optional() .describe( "The name of the boards to return, Must be less than 255 characters.", ), maxResults: z .number() .optional() .describe("The maximum number of results to return, (max: 100)"), startAt: z .number() .optional() .describe("The starting index of the returned boards"), type: z .enum(["scrum", "kanban"]) .optional() .describe("The type of boards to return"), }); - src/tools/list_boards.ts:32-36 (registration)Tool object registration defining the name, description, and input schema for the list_boards tool.
export const LIST_BOARDS_TOOL: Tool = { name: "list_boards", description: "List boards from a project", inputSchema: zodToJsonSchema(listBoardsInputSchema) as Tool["inputSchema"], }; - src/app.ts:39-48 (registration)Central tools array where LIST_BOARDS_TOOL is registered among other tools, exposed via the MCP listTools handler.
export const tools = [ // list LIST_PROJECTS_TOOL, LIST_BOARDS_TOOL, LIST_SPRINTS_FROM_BOARD_TOOL, LIST_ISSUES_FROM_SPRINT_TOOL, // create CREATE_ISSUE_TOOL, ] satisfies Tool[];