Skip to main content
Glama
fleagne

Backlog MCP Server

by fleagne

backlog_get_wiki

Retrieve a specific wiki page from Backlog using its unique page ID. This tool integrates with the Backlog Wiki API to fetch detailed content for project management and collaboration purposes.

Instructions

Performs an wiki get using the Backlog Wiki API.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
wikiIdYesWiki page ID

Implementation Reference

  • The handler function that implements the core execution logic for the 'backlog_get_wiki' tool. It validates input parameters using WikiParamsSchema, fetches wiki details via wikiService.getWiki, and formats the response as text or handles errors.
    const handleGetWiki: ToolHandler = async (args) => {
    	try {
    		try {
    			const validatedParams = WikiParamsSchema.parse(args);
    
    			const text = await wikiService.getWiki(validatedParams);
    
    			return {
    				content: [
    					{
    						type: "text",
    						text: `Wiki details for ${validatedParams.wikiId}:\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,
    		};
    	}
    };
  • Zod schema definition for input validation of the 'backlog_get_wiki' tool, requiring a single 'wikiId' parameter of type integer with description.
    export const WikiParamsSchema = z.object({
    	wikiId: z.number().int().describe("Wiki page ID"),
    });
  • Registers the 'backlog_get_wiki' tool definition for MCP, specifying name, description, and input schema derived from WikiParamsSchema.
    export const WIKI_TOOL: Tool = createTool(
    	"backlog_get_wiki",
    	"Performs an wiki get using the Backlog Wiki API.",
    	WikiParamsSchema,
    );
  • Maps the tool name 'backlog_get_wiki' to its handler function handleGetWiki in the central toolHandlers registry.
    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,
    };
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the tool performs a 'get' operation, implying read-only behavior, but does not specify whether it retrieves content, metadata, or both, nor does it cover error handling, authentication needs, or rate limits. This leaves significant gaps for a tool with mutation siblings like 'backlog_add_wiki.'

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence with no wasted words, making it appropriately sized. However, it is not front-loaded with critical information (e.g., purpose or usage), and the phrasing 'an wiki get' is slightly awkward, though not detrimental to clarity.

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 the complexity of interacting with a wiki API and the lack of annotations and output schema, the description is incomplete. It does not explain what the tool returns (e.g., wiki content or details), error conditions, or how it fits within the broader toolset, leaving the agent with insufficient context for effective use.

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?

The input schema has 100% description coverage, with 'wikiId' documented as 'Wiki page ID.' The description adds no additional meaning beyond this, such as format examples or constraints. Since schema coverage is high, the baseline score of 3 is appropriate, as the description does not compensate but also does not detract.

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

Purpose3/5

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

The description states the tool 'Performs an wiki get using the Backlog Wiki API,' which identifies the action ('get') and resource ('wiki'), but it is vague about what 'get' entails (e.g., retrieving content or metadata) and does not distinguish it from sibling tools like 'backlog_get_wikis' (plural) or 'backlog_get_issue.' It avoids tautology by not merely restating the name, but lacks specificity.

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?

No guidance is provided on when to use this tool versus alternatives. It does not mention prerequisites (e.g., needing a wiki ID), exclusions, or comparisons to siblings such as 'backlog_get_wikis' for listing wikis or 'backlog_get_issue' for issues. The description implies usage only through the generic API reference, offering no contextual direction.

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

Related 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/fleagne/backlog-mcp-server'

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