update_wiki
Modify existing wiki pages in Backlog by updating content, name, and notification settings to maintain accurate project documentation.
Instructions
Updates an existing wiki page
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| wikiId | Yes | Wiki ID | |
| name | No | Name of the wiki page | |
| content | No | Content of the wiki page | |
| mailNotify | No | Whether to send notification emails (default: false) |
Implementation Reference
- src/tools/updateWiki.ts:46-55 (handler)The handler function that implements the core logic of the 'update_wiki' tool, parsing the wikiId and calling backlog.patchWiki to update the wiki page.handler: async ({ wikiId, name, content, mailNotify }) => { const wikiIdNumber = typeof wikiId === 'string' ? parseInt(wikiId, 10) : wikiId; return backlog.patchWiki(wikiIdNumber, { name, content, mailNotify, }); },
- src/tools/updateWiki.ts:7-28 (schema)Input schema definition for the 'update_wiki' tool using Zod, defining parameters wikiId, name, content, and mailNotify.const updateWikiSchema = buildToolSchema((t) => ({ wikiId: z .union([z.string(), z.number()]) .describe(t('TOOL_UPDATE_WIKI_ID', 'Wiki ID')), name: z .string() .optional() .describe(t('TOOL_UPDATE_WIKI_NAME', 'Name of the wiki page')), content: z .string() .optional() .describe(t('TOOL_UPDATE_WIKI_CONTENT', 'Content of the wiki page')), mailNotify: z .boolean() .optional() .describe( t( 'TOOL_UPDATE_WIKI_MAIL_NOTIFY', 'Whether to send notification emails (default: false)' ) ), }));
- src/tools/tools.ts:122-128 (registration)Registration of the updateWikiTool in the 'wiki' toolset group within the allTools function.tools: [ getWikiPagesTool(backlog, helper), getWikisCountTool(backlog, helper), getWikiTool(backlog, helper), addWikiTool(backlog, helper), updateWikiTool(backlog, helper), ],
- src/tools/updateWiki.ts:43-45 (schema)Tool schema (input and output) and important fields definition in the tool definition object.schema: z.object(updateWikiSchema(t)), outputSchema: WikiSchema, importantFields: ['id', 'name', 'content', 'updatedUser'],