Skip to main content

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 NameDescription
docs_searchSemantic search across Allium documentation

Tool Usage

Search Documentation

Search Allium documentation semantically to help your agent understand available data, APIs, and features:
{
  "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

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 explorer_search_schemas to find specific table IDs
  3. Use explorer_fetch_schema to get detailed schema information

API Understanding

When an agent needs to understand how to use Allium APIs:
  1. Search documentation for API endpoints
  2. Find examples and use cases
  3. Understand parameters and response formats

Feature Discovery

When an agent needs to discover what’s possible:
  1. Search for use cases and examples
  2. Find supported blockchains and data types
  3. Understand data freshness and availability