Agent Tools Reference
Complete reference for all Agent tools and their parameters.
Agent Tools Reference
The Agent has 12 specialized tools for retrieving documents, querying graphs, and generating visualizations. This page documents all tools and their parameters.
Document tools
retrieve_chunks
Semantic search for document chunks with citations. The primary retrieval tool.
| Parameter | Type | Default | Description |
|---|---|---|---|
| query | string | required | Search query to find relevant chunks |
| limit | int | 8 | Maximum chunks to return (1-50) |
| min_score | float | 0.0 | Minimum relevance score (0.0-1.0) |
| use_reranking | bool | true | Apply reranking for better results |
| use_colpali | bool | false | Include visual/image search for tables, charts, diagrams |
| search_mode | string | "hybrid" | Search strategy: "semantic", "lexical", or "hybrid" |
Search modes:
- semantic — Embedding-based similarity. Best for conceptual queries.
- lexical — BM25/full-text search. Best for exact names, quotes, identifiers.
- hybrid — Combines both with Reciprocal Rank Fusion. Default for most queries.
Returns: Documents grouped by section, with chunks containing citation_key for inline citations.
retrieve_document
Get full document content by ID or name.
| Parameter | Type | Default | Description |
|---|---|---|---|
| document_id | string | required | Document ID or filename |
Returns: Full document text content and metadata.
list_documents
List accessible documents with metadata and token estimates.
| Parameter | Type | Default | Description |
|---|---|---|---|
| limit | int | 20 | Maximum documents to return |
| offset | int | 0 | Pagination offset |
Returns: List of documents with filename, size, status, and estimated token count.
get_document_stats
Get collection statistics for retrieval planning.
| Parameter | Type | Default | Description |
|---|---|---|---|
| (none) | — | — | No parameters |
Returns: Total document count, total chunks, average document size, content type breakdown.
search_documents
Filter documents by content type, date, filename, or page count.
| Parameter | Type | Default | Description |
|---|---|---|---|
| query | string | optional | Text search in filename/metadata |
| content_type | string | optional | Filter by MIME type |
| date_from | string | optional | Filter by upload date (ISO format) |
| date_to | string | optional | Filter by upload date (ISO format) |
| min_pages | int | optional | Minimum page count |
| max_pages | int | optional | Maximum page count |
Returns: Filtered list of documents matching criteria.
get_document_summary
Get pre-computed document or section summaries.
| Parameter | Type | Default | Description |
|---|---|---|---|
| document_id | string | required | Document ID |
| section | string | optional | Specific section name |
Returns: Document summary and/or section summaries.
Graph tools
list_graphs
List available knowledge graphs.
| Parameter | Type | Default | Description |
|---|---|---|---|
| (none) | — | — | No parameters |
Returns: List of graphs with name, document count, entity count, relationship count.
graph_overview
Get graph structure overview including types, top entities, and statistics.
| Parameter | Type | Default | Description |
|---|---|---|---|
| graph_name | string | optional | Specific graph name (defaults to first available) |
Returns: Entity types, relationship types, top connected entities, graph statistics.
entity_search
Search entities by name, type, or properties.
| Parameter | Type | Default | Description |
|---|---|---|---|
| query | string | optional | Semantic search on entity labels |
| entity_types | list | optional | Filter by type(s): ["PERSON", "ORGANIZATION"] |
| properties | dict | optional | Filter by property values: {"role": "CEO"} |
| graph_name | string | optional | Specific graph name |
| sort_by | string | "relevance" | Sort: "relevance", "connections", "label", "recent" |
| limit | int | 25 | Maximum entities to return (1-100) |
| response_detail | string | "compact" | Detail level: "compact" or "full" |
| include_chunk_preview | bool | false | Include source chunk previews |
| include_top_connections | bool | false | Include top 5 connections per entity |
Returns: List of entities with label, type, properties, connection count.
get_entity_sources
Get source documents and chunks for specific entities.
| Parameter | Type | Default | Description |
|---|---|---|---|
| entity_id | string | required | Entity ID |
| limit | int | 10 | Maximum sources to return |
Returns: Source chunks and documents that mention the entity.
knowledge_graph_query
Query graph for paths and subgraphs between entities.
| Parameter | Type | Default | Description |
|---|---|---|---|
| start_entity | string | required | Starting entity name or ID |
| end_entity | string | optional | Target entity name or ID |
| max_hops | int | 3 | Maximum relationship hops |
| relationship_types | list | optional | Filter by relationship types |
| graph_name | string | optional | Specific graph name |
Returns: Path(s) between entities, intermediate nodes, relationship details.
Visualization tools
get_visualization_help
Get syntax examples for creating diagrams, charts, and mind maps.
| Parameter | Type | Default | Description |
|---|---|---|---|
| visualization_type | string | optional | Specific type: "mermaid", "chart", "mindmap" |
Returns: Syntax examples and usage guidelines for generating visualizations.
Supported visualization types:
- Mermaid diagrams — Flowcharts, sequence diagrams, timelines, Gantt charts, state diagrams, ER diagrams
- Data charts — Bar, line, area, pie, radar, scatter
- Mind maps — Hierarchical concept breakdowns
Tool behavior
Automatic selection
The Agent automatically chooses tools based on your question. You don't need to specify tools explicitly, but you can direct tool use by phrasing your question appropriately.
ModelRetry
When a tool encounters an issue (permissions, empty results, invalid parameters), it may raise a ModelRetry that prompts the Agent to try a different approach. This is shown in the tool timeline.
Permissions
Tools respect your document and graph permissions:
- Documents require read access
- Graphs require graph access enabled for your account
- Team documents require team membership