get_wiki_pages
Search for Wiki pages within a Backlog project using a keyword. Input the project ID or key to retrieve a list of relevant pages for efficient project documentation management.
Instructions
Returns list of Wiki pages
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | No | Keyword to search for in Wiki pages | |
| projectIdOrKey | Yes | Project ID or project key |
Implementation Reference
- src/tools/getWikiPages.ts:51-64 (handler)The handler function that executes the get_wiki_pages tool logic: resolves project ID or key using resolveIdOrKey utility and calls the backlog.getWikis API.handler: async ({ projectId, projectKey, keyword }) => { const result = resolveIdOrKey( 'project', { id: projectId, key: projectKey }, t ); if (!result.ok) { throw result.error; } return backlog.getWikis({ projectIdOrKey: result.value, keyword, }); },
- src/tools/getWikiPages.ts:8-33 (schema)Input schema definition for the get_wiki_pages tool using Zod, including optional projectId, projectKey, and keyword parameters.const getWikiPagesSchema = buildToolSchema((t) => ({ projectId: z .number() .optional() .describe( t( 'TOOL_GET_WIKI_PAGES_PROJECT_ID', 'The numeric ID of the project (e.g., 12345)' ) ), projectKey: z .string() .optional() .describe( t( 'TOOL_GET_WIKI_PAGES_PROJECT_KEY', "The key of the project (e.g., 'PROJECT')" ) ), keyword: z .string() .optional() .describe( t('TOOL_GET_WIKI_PAGES_KEYWORD', 'Keyword to search for in Wiki pages') ), }));
- src/tools/tools.ts:113-118 (registration)Registration of the getWikiPagesTool in the 'wiki' toolset group within the allTools export.tools: [ getWikiPagesTool(backlog, helper), getWikisCountTool(backlog, helper), getWikiTool(backlog, helper), addWikiTool(backlog, helper), ],