Skip to main content
Glama

outline_search_documents

Search for documents in Outline using text queries to find relevant content quickly and manage information retrieval.

Instructions

Search for documents in Outline

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYesSearch query to find documents
limitNoMaximum number of results to return (default: 25)

Implementation Reference

  • Handler for 'outline_search_documents' inside the CallToolRequest handler.
    case 'outline_search_documents':
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify(
              await this.outlineClient.searchDocuments(args.query as string, args.limit as number),
              null,
              2
            ),
          },
        ],
      };
  • The actual implementation of searching documents within the OutlineClient class.
    async searchDocuments(query: string, limit: number = 25): Promise<Document[]> {
      const endpoints = ['/api/documents.search', '/api/documents/search', '/api/document/search'];
    
      for (const endpoint of endpoints) {
        try {
          const response = await this.api.post(endpoint, { query, limit });
          return response.data.data || response.data;
        } catch (error: any) {
          if (error.response?.status === 404 && endpoint !== endpoints[endpoints.length - 1]) {
            console.error(`Endpoint ${endpoint} not found, trying next...`);
            continue;
          }
          throw error;
        }
      }
      throw new Error('No valid endpoint found for searching documents');
    }
  • Registration and schema definition for 'outline_search_documents'.
    {
      name: 'outline_search_documents',
      description: 'Search for documents in Outline',
      inputSchema: {
        type: 'object',
        properties: {
          query: {
            type: 'string',
            description: 'Search query to find documents',
          },
          limit: {
            type: 'number',
            description: 'Maximum number of results to return (default: 25)',
            default: 25,
          },
        },
        required: ['query'],
      },
    },

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/HelicopterHelicopter/outline-mcp-server'

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