Skip to main content
Glama
huiseo

Outline Wiki MCP Server

by huiseo

get_collection_structure

Retrieve document hierarchy within a collection to understand organization and relationships between documents in Outline wiki.

Instructions

Get document hierarchy within a collection.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
collectionIdYes

Implementation Reference

  • The handler function that implements the get_collection_structure tool by calling the Outline API endpoint '/collections.documents' with the provided collectionId.
    async get_collection_structure(args: GetCollectionStructureInput) {
      const { data } = await apiCall(() =>
        apiClient.post<unknown>('/collections.documents', { id: args.collectionId })
      );
      return data;
    },
  • Zod input schema for the get_collection_structure tool, requiring a valid UUID collectionId.
    export const getCollectionStructureSchema = z.object({ collectionId });
  • src/lib/tools.ts:51-55 (registration)
    Registration of the get_collection_structure tool in the allTools array, providing name, description, and schema reference for MCP tool definition.
    createTool(
      'get_collection_structure',
      'Get document hierarchy within a collection.',
      'get_collection_structure'
    ),
  • Mapping of get_collection_structure tool name to its Zod schema in the central toolSchemas registry.
    get_collection_structure: getCollectionStructureSchema,
  • TypeScript type definition for the input of get_collection_structure, inferred from the Zod schema.
    export type GetCollectionStructureInput = z.infer<typeof getCollectionStructureSchema>;
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 but offers minimal behavioral insight. It implies a read-only operation ('Get'), but doesn't disclose details like permissions needed, rate limits, error conditions, or what 'hierarchy' entails (e.g., tree structure, metadata). For a tool with no annotations, 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 that directly states the tool's function without unnecessary words. It's front-loaded and wastes no space, 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 minimal parameter guidance, the description is incomplete. It doesn't explain what 'document hierarchy' includes (e.g., nesting levels, metadata), return format, or error handling. For a tool that likely returns structured data, this leaves too much undefined for effective agent 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 1 parameter with 0% description coverage, and the tool description doesn't add any parameter-specific information. It mentions 'collectionId' implicitly via 'collection' but doesn't explain its format (UUID) or sourcing. Baseline is 3 due to the single parameter, but the description fails to compensate for the lack of schema details.

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 action ('Get') and resource ('document hierarchy within a collection'), making the purpose understandable. It distinguishes from siblings like 'get_document' (single document) and 'list_collections' (collections themselves), though it doesn't explicitly contrast them. The description is specific but lacks explicit 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?

No guidance is provided on when to use this tool versus alternatives. The description doesn't mention prerequisites, context, or exclusions, such as whether it works on archived collections or requires specific permissions. It leaves the agent to infer usage from the tool name alone.

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-smart-mcp'

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