search_documents
Read-onlyIdempotent
Search across documents in your knowledge base using keywords. Get ranked results with content snippets, pagination, and optional collection filter.
Instructions
Searches for documents using keywords or phrases across your knowledge
base.
IMPORTANT: The search performs full-text search across all document
content and titles. Results are ranked by relevance, with exact
matches
and title matches typically ranked higher. The search will return
snippets of content (context) where the search terms appear in the
document. You can limit the search to a specific collection by
providing
the collection_id.
PAGINATION: By default, returns up to 25 results at a time. If more
results exist, use the 'offset' parameter to fetch additional pages.
For example, use offset=25 to get results 26-50, offset=50 for
51-75, etc.
STATUS FILTER: By default, searches published documents only. Pass
status_filter to include other document states. Allowed values are
"draft", "archived", and "published".
Use this tool when you need to:
- Find documents containing specific terms or topics
- Locate information across multiple documents
- Search within a specific collection using collection_id
- Discover content based on keywords
- Browse through large result sets using limit and offset
Args:
query: Search terms (e.g., "vacation policy" or "project plan")
collection_id: Optional collection to limit the search to
limit: Maximum results to return (default: 25, max: 100)
offset: Number of results to skip for pagination (default: 0)
status_filter: Optional list of statuses to search. Allowed values
are "draft", "archived", and "published". Defaults to
["published"] when omitted.
Returns:
Formatted string containing search results with document titles,
contexts, and pagination information
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | ||
| collection_id | No | ||
| limit | No | ||
| offset | No | ||
| status_filter | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |