search_documents
Find documents in Outline wiki by keyword with paginated results for efficient information retrieval.
Instructions
Search documents by keyword. Supports pagination.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | ||
| collectionId | No | ||
| limit | No | ||
| offset | No |
Implementation Reference
- src/lib/handlers/search.ts:26-36 (handler)Core handler function implementing the search_documents tool logic: performs API call to search documents by query (optionally scoped to collection), supports pagination, formats and returns results.
async search_documents(args: SearchDocumentsInput) { const { data } = await apiCall(() => apiClient.post<SearchResult[]>('/documents.search', { query: args.query, collectionId: args.collectionId, limit: args.limit, offset: args.offset, }) ); return formatSearchResults(data || [], baseUrl); }, - src/lib/schemas.ts:21-26 (schema)Zod schema defining input parameters for search_documents: query (required string), optional collectionId (UUID), limit (default 10), offset (default 0).
export const searchDocumentsSchema = z.object({ query: z.string().min(1, 'Query is required'), collectionId: collectionId.optional(), limit: limit.default(10), offset, }); - src/lib/tools.ts:37-40 (registration)Tool registration in allTools array: creates MCP tool definition from schema with name 'search_documents' and description.
'search_documents', 'Search documents by keyword. Supports pagination.', 'search_documents' ), - src/lib/schemas.ts:213-213 (schema)Mapping of tool name 'search_documents' to its Zod schema in the central toolSchemas record.
search_documents: searchDocumentsSchema, - src/lib/schemas.ts:213-213 (registration)Tool schema registration in toolSchemas map used by tool definitions.
search_documents: searchDocumentsSchema,