backlog_get_wikis
Retrieve wiki pages from a Backlog project by specifying the project ID/key. Use keywords to filter and search relevant content within the wikis.
Instructions
Performs list wikis get using the Backlog Wiki API
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| keywords | No | Keyword for searching | |
| projectIdOrKey | Yes | Project ID or Project Key |
Implementation Reference
- src/tools/handlers.ts:272-304 (handler)The main handler function for the 'backlog_get_wikis' tool. It validates input parameters using WikisParamsSchema, calls wikiService.getWikis to fetch the data, formats the response as text, and handles errors appropriately.
const handleGetWikis: ToolHandler = async (args) => { try { try { const validatedParams = WikisParamsSchema.parse(args); const text = await wikiService.getWikis(validatedParams); return { content: [ { type: "text", text: `Results for your query:\n${text}`, }, ], isError: false, }; } catch (validationError) { throw new ValidationError( `Invalid parameters: ${validationError instanceof Error ? validationError.message : String(validationError)}`, ); } } catch (error) { return { content: [ { type: "text", text: `Error: ${formatError(error)}`, }, ], isError: true, }; } }; - src/tools/handlers.ts:442-455 (registration)The toolHandlers object registers 'backlog_get_wikis' to the handleGetWikis function, mapping tool names to their handler implementations.
export const toolHandlers: Record<ToolName, ToolHandler> = { backlog_get_projects: handleGetProjects, backlog_get_project: handleGetProject, backlog_get_issues: handleGetIssues, backlog_get_issue: handleGetIssue, backlog_add_issue: handleAddIssue, backlog_update_issue: handleUpdateIssue, backlog_delete_issue: handleDeleteIssue, backlog_get_wikis: handleGetWikis, backlog_get_wiki: handleGetWiki, backlog_add_wiki: handleAddWiki, backlog_update_wiki: handleUpdateWiki, backlog_delete_wiki: handleDeleteWiki, }; - src/core/schema.ts:181-184 (schema)Zod schema defining the input parameters for the backlog_get_wikis tool: requires projectIdOrKey, optional keyword.
export const WikisParamsSchema = z.object({ projectIdOrKey: z.string().describe("Project ID or Project Key"), keyword: z.string().optional().describe("Keyword for searching"), }); - src/tools/toolDefinitions.ts:571-575 (schema)MCP Tool definition for 'backlog_get_wikis', including name, description, and input schema generated from WikisParamsSchema.
export const WIKIS_TOOL: Tool = createTool( "backlog_get_wikis", "Performs list wikis get using the Backlog Wiki API", WikisParamsSchema, ); - src/services/wikiService.ts:11-13 (helper)wikiService.getWikis wrapper that delegates to the backlogAPI.getWikis method.
async getWikis(params: WikisParams): Promise<string> { try { return await backlogAPI.getWikis(params);