> ## Documentation Index
> Fetch the complete documentation index at: https://docs.allium.so/llms.txt
> Use this file to discover all available pages before exploring further.
# Documentation Tools
> Search Allium documentation semantically to help agents understand available data and features.
## Overview
The documentation search tool allows AI agents to semantically search across Allium's documentation to find relevant information about data schemas, APIs, features, and use cases.
## Available Tools
| Tool Name | Description |
| :------------------- | :--------------------------------------------------------------- |
| `docs_search` | Semantic search across Allium documentation |
| `docs_browse_docs` | Browse documentation hierarchy like a filesystem |
| `docs_get_docs_file` | Get complete documentation file content without character limits |
## Tool Usage
### Search Documentation
Search Allium documentation semantically to help your agent understand available data, APIs, and features:
```json theme={null}
{
"name": "docs_search",
"arguments": {
"query": "how to query DEX trades"
}
}
```
**Example queries:**
* "What tables contain NFT trade data?"
* "How do I get wallet balances?"
* "What blockchains are supported for DEX data?"
* "How to query token transfers on Ethereum?"
This tool helps agents:
* Discover available data schemas and tables
* Understand API endpoints and their usage
* Find examples and use cases
* Learn about supported blockchains and features
### Browse Documentation
Navigate Allium's documentation hierarchy like a filesystem:
```json theme={null}
{
"name": "docs_browse_docs",
"arguments": {
"path": "" // Empty = list root directories
}
}
```
**Navigation paths:**
* `""` or `"."` → List root directories and files
* `"api"` → List contents of api/ directory
* `"historical-data"` → List contents of historical-data/ directory
* `"historical-data/overview.mdx"` → Get file content (limited to 5000 characters)
**Use cases:**
* Discover available documentation categories
* Navigate through nested documentation directories
* Retrieve markdown content from specific files
File content returned by `browse_docs` is limited to **5000 characters**. If truncated, use `get_docs_file` to retrieve the complete content.
### Get Full Documentation File
Retrieve complete documentation file content without character limits:
```json theme={null}
{
"name": "docs_get_docs_file",
"arguments": {
"path": "api/overview.mdx"
}
}
```
**When to use:**
* You called `browse_docs` and the content was truncated
* The truncated content was relevant to answering the question
* You need the rest of the file to provide a complete answer
**Do NOT use for:**
* Browsing directories (use `browse_docs` instead)
* Initial file exploration (use `browse_docs` first)
* Files where the first 5000 characters were sufficient
## Use Cases
### Schema Discovery
When an agent needs to find relevant tables for a query:
1. Use `docs_search` to find documentation about the data type
2. Use `docs_browse_docs` to navigate to specific schema documentation
3. Use `explorer_search_schemas` to find specific table IDs
4. Use `explorer_browse_schemas` or `explorer_fetch_schema` to get detailed schema information
### API Understanding
When an agent needs to understand how to use Allium APIs:
1. Use `docs_search` to find relevant API documentation
2. Use `docs_browse_docs` to navigate API reference sections
3. Use `docs_get_docs_file` if you need complete endpoint documentation
4. Find examples and understand parameters and response formats
### Feature Discovery
When an agent needs to discover what's possible:
1. Use `docs_search` to find use cases and examples
2. Use `docs_browse_docs` to explore available features by category
3. Find supported blockchains, data types, and understand data freshness
## Related Resources
Explore available blockchain data schemas
Query tools for blockchain data