Skip to main content
Glama
nulab

Backlog MCP Server

get_wiki

Retrieve specific wiki page content from Backlog project management using the wiki ID to access documentation and project information.

Instructions

Returns information about a specific wiki page

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
wikiIdYesWiki ID

Implementation Reference

  • The handler function that executes the core logic of the 'get_wiki' tool by parsing the wikiId and calling backlog.getWiki(wikiIdNumber) to retrieve the wiki page information.
    handler: async ({ wikiId }) => {
      const wikiIdNumber =
        typeof wikiId === 'string' ? parseInt(wikiId, 10) : wikiId;
      return backlog.getWiki(wikiIdNumber);
    },
  • Input schema definition for the 'get_wiki' tool using Zod, specifying the wikiId parameter which can be a string or number.
    const getWikiSchema = buildToolSchema((t) => ({
      wikiId: z
        .union([z.string(), z.number()])
        .describe(t('TOOL_GET_WIKI_ID', 'Wiki ID')),
    }));
  • Registration of the 'get_wiki' tool by instantiating getWikiTool and adding it to the 'wiki' toolset in the allTools function.
    getWikiTool(backlog, helper),
  • The complete tool definition and export of the 'get_wiki' tool, including name, description, schema, output schema, and handler.
    export const getWikiTool = (
      backlog: Backlog,
      { t }: TranslationHelper
    ): ToolDefinition<
      ReturnType<typeof getWikiSchema>,
      (typeof WikiSchema)['shape']
    > => {
      return {
        name: 'get_wiki',
        description: t(
          'TOOL_GET_WIKI_DESCRIPTION',
          'Returns information about a specific wiki page'
        ),
        schema: z.object(getWikiSchema(t)),
        outputSchema: WikiSchema,
        importantFields: ['id', 'projectId', 'name', 'content'],
        handler: async ({ wikiId }) => {
          const wikiIdNumber =
            typeof wikiId === 'string' ? parseInt(wikiId, 10) : wikiId;
          return backlog.getWiki(wikiIdNumber);
        },
      };
    };
Behavior2/5

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

No annotations are provided, so the description carries full burden. It states this is a read operation ('Returns'), but doesn't disclose behavioral traits like authentication needs, rate limits, error handling, or response format. For a tool with no annotation coverage, this is a significant gap in transparency.

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?

The description is a single, efficient sentence with zero waste. It's front-loaded with the core purpose and appropriately sized for a simple tool, making it easy to parse quickly.

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

Completeness2/5

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

Given no annotations, no output schema, and a simple parameter schema, the description is incomplete. It doesn't explain what information is returned, error conditions, or behavioral context, which is inadequate for a tool that likely interacts with a wiki system where details matter.

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 coverage is 100%, with the parameter 'wikiId' documented in the schema. The description doesn't add any meaning beyond this, such as explaining what a wiki ID is or providing examples. Baseline 3 is appropriate when the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb ('Returns') and resource ('information about a specific wiki page'), making the purpose unambiguous. However, it doesn't distinguish this from sibling tools like 'get_wiki_pages' (which likely lists multiple wikis) or 'get_document' (which might return different content types), missing full sibling differentiation.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention sibling tools like 'get_wiki_pages' for listing wikis or 'get_document' for other content, nor does it specify prerequisites or exclusions, leaving usage context unclear.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/nulab/backlog-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server