Skip to main content
Glama
huiseo
by huiseo

get_document_backlinks

Find documents linking to a specific Outline wiki document to understand connections and references within your knowledge base.

Instructions

Find other documents linking to this document.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
documentIdYes

Implementation Reference

  • The handler function that implements the core logic of the get_document_backlinks tool. It fetches the document information using the Outline API and formats the backlinks for return.
    async get_document_backlinks(args: GetDocumentBacklinksInput) {
      const { data } = await apiCall(() =>
        apiClient.post<OutlineDocument>('/documents.info', { id: args.documentId })
      );
      return {
        documentId: args.documentId,
        backlinks: formatBacklinks(data.backlinks || [], baseUrl),
      };
    },
  • Zod schema defining the input for the tool, requiring a documentId string.
    export const getDocumentBacklinksSchema = z.object({ documentId });
  • Registers the tool in the allTools array, specifying its name, description, and linking to the schema for MCP tool definition.
    'get_document_backlinks',
    'Find other documents linking to this document.',
    'get_document_backlinks'
  • Maps the tool name to its schema in the toolSchemas object used by tool definitions.
    get_document_backlinks: getDocumentBacklinksSchema,
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It states what the tool does but doesn't describe how it behaves: no information about permissions needed, rate limits, pagination, error conditions, or what the output looks like. For a tool with zero annotation coverage, this leaves significant gaps in understanding its operational characteristics.

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 that gets straight to the point with zero wasted words. It's appropriately sized for a simple lookup tool and front-loads the core functionality immediately.

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 0% schema description coverage, the description is insufficiently complete. It explains what the tool does at a high level but doesn't provide enough context about behavior, parameters, or results for an agent to use it effectively without additional trial-and-error.

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 description implies a 'documentId' parameter through 'this document', but doesn't explain what format it expects or where to get it. With 0% schema description coverage and 1 parameter, the description adds minimal semantic context beyond what's inferable from the schema. This meets the baseline for a single parameter tool but doesn't compensate for the lack of schema documentation.

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 'find' and resource 'other documents linking to this document', making the purpose immediately understandable. It doesn't explicitly distinguish from siblings like 'find_related' or 'get_document', but the specific focus on backlinks is reasonably distinct. The description avoids tautology by not just restating the tool name.

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 like 'find_related' or 'get_document'. It doesn't mention prerequisites, context, or exclusions. While the purpose is clear, there's no help for an agent deciding between this and other document-related tools in the sibling list.

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/huiseo/outline-wiki-mcp'

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