Skip to main content
Glama
huiseo

Outline Wiki MCP Server

by huiseo

smart_status

Check if AI-powered features like semantic search and document summarization are enabled and view index statistics in Outline Wiki.

Instructions

Check if smart features are enabled and get index statistics.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The smart_status handler function that fetches brain statistics and returns enabled status, indexed chunks count, and a status message.
    async smart_status() {
      const stats = await brain.getStats();
    
      return {
        enabled: stats.enabled,
        indexedChunks: stats.chunks,
        message: stats.enabled
          ? `Smart features are enabled with ${stats.chunks} indexed chunks.`
          : ERROR_MESSAGES.SMART_FEATURES_DISABLED,
      };
    },
  • Zod input schema for smart_status tool, which requires no parameters (empty object).
    export const smartStatusSchema = z.object({});
  • MCP tool definition registration for smart_status, including name, description, and schema reference.
    createTool(
      'smart_status',
      'Check if smart features are enabled and get index statistics.',
      'smart_status'
    ),
  • Handler registration where createSmartHandlers (including smart_status) is spread into the main all-handlers object.
    export function createAllHandlers(ctx: AppContext): ToolHandlers {
      return {
        ...createSearchHandlers(ctx),
        ...createDocumentHandlers(ctx),
        ...createCollectionHandlers(ctx),
        ...createCommentHandlers(ctx),
        ...createBatchHandlers(ctx),
        ...createSmartHandlers(ctx),
      } as ToolHandlers;
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 important behavioral aspects: whether this is a read-only operation, what permissions might be required, whether it affects system state, what format the statistics are returned in, or any rate limits. For a status-checking tool with zero annotation coverage, this is inadequate.

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 perfectly concise - a single sentence that efficiently communicates the tool's dual purpose. Every word earns its place, with no redundant information or unnecessary elaboration. It's front-loaded with the core functionality.

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 tool has no annotations, no output schema, and the description provides minimal behavioral context, this is incomplete. For a status-checking tool that presumably returns system information, the description should at minimum indicate what 'index statistics' includes or the format of the response. The current description leaves too many unknowns for effective tool selection and invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has zero parameters with 100% schema description coverage, so the baseline is 4. The description doesn't need to explain parameters since none exist, and it appropriately focuses on the tool's purpose rather than parameter 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 tool's purpose with specific verbs ('check' and 'get') and resources ('smart features' and 'index statistics'). It distinguishes itself from siblings by focusing on system status rather than document/content operations. However, it doesn't explicitly differentiate from potential similar status-checking tools that might exist.

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. Given the sibling tools are all document/content management operations, this tool stands alone for system status checking, but the description doesn't explicitly state this distinction or provide any context about appropriate usage scenarios.

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