io.github.Airpote/avalanche-docs

Official44 tools

by yassirboudda · JavaScript

Avalanche AVAX MCP

Search and retrieve Avalanche blockchain documentation for building on AVAX.

Search and retrieve Avalanche blockchain documentation for AVAX development.

Captured live from the server via tools/list.

docs_search

Search body-level chunks across Avalanche documentation, academy courses, integrations, and blog posts. Returns source citations and matching excerpts.

Parameters (3)

querystringrequired
The search query
sourcestring
Filter by documentation source (optional)
limitnumber
Maximum number of chunk results (default: 10)

docs_fetch

Fetch a specific documentation page as markdown

Parameters (1)

urlstringrequired
The page URL path (e.g., /docs/primary-network/overview)

docs_list_sections

List available documentation sections and their page counts

No parameters.

cli_lookup_command

Look up Avalanche CLI, Platform CLI, and tmpnet command guidance in the docs. Returns cited command references and task docs.

Parameters (3)

querystringrequired
Command, flag, or task to look up
clistring
CLI surface to search. Defaults to all.
limitnumber
Maximum number of results (default: 8)

rpc_lookup_method

Look up Avalanche RPC methods and API guides across C-Chain, P-Chain, X-Chain, Subnet-EVM, and node RPC docs.

Parameters (3)

querystringrequired
RPC method, namespace, or task to look up
chainstring
RPC area to search. Defaults to all.
limitnumber
Maximum number of results (default: 8)

acp_lookup

Look up Avalanche Community Proposals (ACPs) by number, title, or topic. When a number is provided the structured ACP record is returned (title, status, track, authors, cross-references).

Parameters (3)

querystring
ACP title, topic, or keyword
numbernumber
ACP number, if known
limitnumber
Maximum number of results (default: 8)

acp_list

List Avalanche Community Proposals with structured fields, optionally filtered by status (Activated, Implementable, Proposed, Stale, Withdrawn) or track (Standards, Best Practices, Meta, Subnet).

Parameters (3)

statusstring
Filter by ACP status (case-insensitive)
trackstring
Filter by ACP track. Matches Standards, Best Practices, Meta, or Subnet.
limitnumber
Maximum number of ACPs to return (default: 50)

avalanche_docs_search

Compatibility alias for docs_search. Prefer docs_search for new clients.

Parameters (3)

querystringrequired
The search query
sourcestring
Filter by documentation source (optional)
limitnumber
Maximum number of chunk results (default: 10)

avalanche_docs_fetch

Compatibility alias for docs_fetch. Prefer docs_fetch for new clients.

Parameters (1)

urlstringrequired
The page URL path (e.g., /docs/primary-network/overview)

avalanche_docs_list_sections

Compatibility alias for docs_list_sections. Prefer docs_list_sections for new clients.

No parameters.

blockchain_get_native_balance

Get the native AVAX balance of an address on C-Chain

Parameters (2)

addressstringrequired
EVM address (0x...)
chainIdstring
Chain ID — "43114" for C-Chain mainnet, "43113" for Fuji testnet

blockchain_get_contract_info

Check if an address is a contract and get its ERC20 name/symbol if applicable

Parameters (2)

addressstringrequired
EVM address (0x...)
chainIdstring
Chain ID — "43114" for C-Chain mainnet, "43113" for Fuji testnet

blockchain_lookup_transaction

Look up a transaction by hash on Avalanche (C-Chain, P-Chain, or X-Chain). Supports 0x format (C-Chain) and CB58 format (P/X-Chain).

Parameters (2)

txHashstringrequired
Transaction hash (0x... for C-Chain, CB58 for P/X-Chain)
networkstring
Network to search

blockchain_lookup_address

Look up an address — balance, contract info. Use when users paste an 0x address.

Parameters (2)

addressstringrequired
The address to look up (0x format)
chainIdstring
Chain ID — "43114" for C-Chain mainnet, "43113" for Fuji testnet

blockchain_lookup_subnet

Look up a Subnet / L1 by its ID — validators, chains, and configuration.

Parameters (2)

subnetIdstringrequired
The Subnet ID
networkstring

blockchain_lookup_chain

Look up a blockchain by its ID — name, VM type, and subnet.

Parameters (2)

chainIdstringrequired
The blockchain ID
networkstring

blockchain_lookup_validator

Look up a validator by node ID — stake, uptime, delegation info.

Parameters (3)

nodeIdstringrequired
Node ID (e.g. NodeID-...)
subnetIdstring
Subnet ID (default: Primary Network)
networkstring

github_search_code

Search for code across core Avalanche GitHub repositories including avalanchego, subnet-evm, coreth, libevm, avalanche-cli, platform-cli, icm-services, icm-contracts, avalanche-network-runner, hypersdk, and builders-hub.

Parameters (4)

querystringrequired
The search query string to find relevant code.
repostring
The repository to search in. Defaults to "all".
languagestring
Filter results by programming language. Defaults to "any".
perPagenumber
Maximum number of GitHub results to return (default: 10).

github_get_file

Retrieve the contents of a specific file from an Avalanche GitHub repository.

Parameters (3)

repostringrequired
The repository to fetch the file from (owner is always ava-labs).
pathstringrequired
The path to the file within the repository.
refstring
The git ref (branch, tag, or commit SHA) to fetch from. Defaults to "HEAD".

github_list_repositories

List the Avalanche GitHub repositories covered by github_search_code and github_get_file.

No parameters.

platform_get_height

Get the current P-Chain block height

Parameters (1)

networkstring
Avalanche network to query (default: mainnet)

platform_get_block

Get a P-Chain block by its block ID

Parameters (3)

blockIDstringrequired
The CB58-encoded block ID
encodingstring
Encoding format for the block (default: json)
networkstring
Avalanche network to query (default: mainnet)

platform_get_block_by_height

Get a P-Chain block by its height

Parameters (3)

heightstringrequired
The block height as a string
encodingstring
Encoding format for the block (default: json)
networkstring
Avalanche network to query (default: mainnet)

platform_get_blockchains

Get all blockchains that exist on the P-Chain

Parameters (1)

networkstring
Avalanche network to query (default: mainnet)

platform_get_subnets

Get information about subnets on the P-Chain

Parameters (2)

idsarray
Optional list of subnet IDs to filter by
networkstring
Avalanche network to query (default: mainnet)

platform_get_current_validators

Get the current validators of a subnet

Parameters (3)

subnetIDstring
The subnet ID to query validators for (default: Primary Network)
nodeIDsarray
Optional list of node IDs to filter by
networkstring
Avalanche network to query (default: mainnet)

platform_get_pending_validators

Get the pending validators of a subnet (validators not yet validating)

Parameters (3)

subnetIDstring
The subnet ID to query pending validators for (default: Primary Network)
nodeIDsarray
Optional list of node IDs to filter by
networkstring
Avalanche network to query (default: mainnet)

platform_get_staking_asset_id

Get the asset ID of the token used for staking on a subnet

Parameters (2)

subnetIDstring
The subnet ID to query the staking asset for (default: Primary Network)
networkstring
Avalanche network to query (default: mainnet)

platform_get_min_stake

Get the minimum staking amounts for validators and delegators on a subnet

Parameters (2)

subnetIDstring
The subnet ID to query minimum stake for (default: Primary Network)
networkstring
Avalanche network to query (default: mainnet)

platform_get_total_stake

Get the total amount staked on a subnet

Parameters (2)

subnetIDstring
The subnet ID to query total stake for (default: Primary Network)
networkstring
Avalanche network to query (default: mainnet)

platform_get_balance

Get the AVAX balance of one or more P-Chain addresses

Parameters (2)

addressesarrayrequired
List of P-Chain addresses to query (e.g. P-avax1...)
networkstring
Avalanche network to query (default: mainnet)

platform_get_utxos

Get UTXOs that reference a given set of P-Chain addresses

Parameters (4)

addressesarrayrequired
List of P-Chain addresses to get UTXOs for
limitnumber
Maximum number of UTXOs to return
sourceChainstring
If fetching atomic UTXOs, the chain they were exported from
networkstring
Avalanche network to query (default: mainnet)

platform_get_tx

Get a P-Chain transaction by its transaction ID

Parameters (3)

txIDstringrequired
The CB58-encoded transaction ID
encodingstring
Encoding format for the transaction (default: json)
networkstring
Avalanche network to query (default: mainnet)

platform_get_tx_status

Get the status of a P-Chain transaction

Parameters (2)

txIDstringrequired
The CB58-encoded transaction ID
networkstring
Avalanche network to query (default: mainnet)

platform_get_current_supply

Get the current total supply of AVAX on a subnet

Parameters (2)

subnetIDstring
The subnet ID to query current supply for (default: Primary Network)
networkstring
Avalanche network to query (default: mainnet)

platform_get_validators_at

Get the validators and their weights of a subnet at a given P-Chain height

Parameters (3)

heightanyrequired
The P-Chain height to query validators at, or "proposed"
subnetIDstring
The subnet ID to query validators for (default: Primary Network)
networkstring
Avalanche network to query (default: mainnet)

info_get_node_version

Get the version of the node, including the database version, git commit, and API compatibility info.

Parameters (1)

networkstring
The Avalanche network to query (default: mainnet)

info_get_network_id

Get the numeric ID of the Avalanche network this node is participating in.

Parameters (1)

networkstring
The Avalanche network to query (default: mainnet)

info_get_network_name

Get the human-readable name of the Avalanche network this node is participating in.

Parameters (1)

networkstring
The Avalanche network to query (default: mainnet)

info_get_blockchain_id

Get the CB58-encoded blockchain ID for a given blockchain alias (e.g., "X", "P", "C").

Parameters (2)

aliasstringrequired
The blockchain alias (e.g., "X", "P", "C", or a full blockchain name)
networkstring
The Avalanche network to query (default: mainnet)

info_is_bootstrapped

Check whether a given chain has finished bootstrapping on the node.

Parameters (2)

chainstringrequired
The chain ID or alias to check (e.g., "X", "P", "C")
networkstring
The Avalanche network to query (default: mainnet)

info_get_tx_fee

Get the current transaction fees for the network, returned in both nAVAX and AVAX.

Parameters (1)

networkstring
The Avalanche network to query (default: mainnet)

info_peers

Get a list of peers this node is connected to. Optionally filter by specific NodeIDs.

Parameters (2)

nodeIDsarray
Optional list of NodeIDs to filter peers by (e.g., ["NodeID-AbC..."]). If omitted, all peers are returned.
networkstring
The Avalanche network to query (default: mainnet)

info_acps

Get information about Avalanche Community Proposals (ACPs), including their status and vote counts.

Parameters (1)

networkstring
The Avalanche network to query (default: mainnet)

README.md7 KBView on GitHub

MCP Registry

The MCP registry provides MCP clients with a list of MCP servers, like an app store for MCP servers.

📤 Publish my MCP server | ⚡️ Live API docs | 👀 Ecosystem vision | 📖 Full documentation

Development Status

2025-10-24 update: The Registry API has entered an API freeze (v0.1) 🎉. For the next month or more, the API will remain stable with no breaking changes, allowing integrators to confidently implement support. This freeze applies to v0.1 while development continues on v0. We'll use this period to validate the API in real-world integrations and gather feedback to shape v1 for general availability. Thank you to everyone for your contributions and patience—your involvement has been key to getting us here!

2025-09-08 update: The registry has launched in preview 🎉 (announcement blog post). While the system is now more stable, this is still a preview release and breaking changes or data resets may occur. A general availability (GA) release will follow later. We'd love your feedback in GitHub discussions or in the #registry-dev Discord (joining details here).

Current key maintainers:

Adam Jones (Anthropic) @domdomegg
Tadas Antanavicius (PulseMCP) @tadasant
Toby Padilla (GitHub) @toby
Radoslav (Rado) Dimitrov (Stacklok) @rdimitrov

Contributing

We use multiple channels for collaboration - see modelcontextprotocol.io/community/communication.

Often (but not always) ideas flow through this pipeline:

Discord - Real-time community discussions
Discussions - Propose and discuss product/technical requirements
Issues - Track well-scoped technical work
Pull Requests - Contribute work towards issues

Quick start:

Pre-requisites

Docker
Go 1.24.x
ko - Container image builder for Go (installation instructions)
golangci-lint v2.4.0

Running the server

bash

# Start full development environment
make dev-compose

This starts the registry at localhost:8080 with PostgreSQL. The database uses ephemeral storage and is reset each time you restart the containers, ensuring a clean state for development and testing.

Note: The registry uses ko to build container images. The make dev-compose command automatically builds the registry image with ko and loads it into your local Docker daemon before starting the services.

By default, the registry seeds from the production API with a filtered subset of servers (to keep startup fast). This ensures your local environment mirrors production behavior and all seed data passes validation. For offline development you can seed from a file without validation with MCP_REGISTRY_SEED_FROM=data/seed.json MCP_REGISTRY_ENABLE_REGISTRY_VALIDATION=false make dev-compose.

The setup can be configured with environment variables in docker-compose.yml - see .env.example for a reference.

<details> <summary>Alternative: Running a pre-built Docker image</summary>

Pre-built Docker images are automatically published to GitHub Container Registry:

bash

# Run latest stable release
docker run -p 8080:8080 ghcr.io/modelcontextprotocol/registry:latest

# Run latest from main branch (continuous deployment)
docker run -p 8080:8080 ghcr.io/modelcontextprotocol/registry:main

# Run specific release version
docker run -p 8080:8080 ghcr.io/modelcontextprotocol/registry:v1.0.0

# Run development build from main branch
docker run -p 8080:8080 ghcr.io/modelcontextprotocol/registry:main-20250906-abc123d

Available tags:

Releases: latest, v1.0.0, v1.1.0, etc.
Continuous: main (latest main branch build)
Development: main-<date>-<sha> (specific commit builds)

</details>

Publishing a server

To publish a server, we've built a simple CLI. You can use it with:

bash

# Build the latest CLI
make publisher

# Use it!
./bin/mcp-publisher --help

See the publisher guide for more details.

Other commands

bash

# Run lint, unit tests and integration tests
make check

There are also a few more helpful commands for development. Run make help to learn more, or look in Makefile.

Architecture

Project Structure

code

├── cmd/                     # Application entry points
│   └── publisher/           # Server publishing tool
├── data/                    # Seed data
├── deploy/                  # Deployment configuration (Pulumi)
├── docs/                    # Documentation
├── internal/                # Private application code
│   ├── api/                 # HTTP handlers and routing
│   ├── auth/                # Authentication (GitHub OAuth, JWT, namespace blocking)
│   ├── config/              # Configuration management
│   ├── database/            # Data persistence (PostgreSQL)
│   ├── service/             # Business logic
│   ├── telemetry/           # Metrics and monitoring
│   └── validators/          # Input validation
├── pkg/                     # Public packages
│   ├── api/                 # API types and structures
│   │   └── v0/              # Version 0 API types
│   └── model/               # Data models for server.json
├── scripts/                 # Development and testing scripts
├── tests/                   # Integration tests
└── tools/                   # CLI tools and utilities
    └── validate-*.sh        # Schema validation tools

Authentication

Publishing supports multiple authentication methods:

GitHub OAuth - For publishing by logging into GitHub
GitHub OIDC - For publishing from GitHub Actions
DNS verification - For proving ownership of a domain and its subdomains
HTTP verification - For proving ownership of a domain

The registry validates namespace ownership when publishing. E.g. to publish...:

io.github.domdomegg/my-cool-mcp you must login to GitHub as domdomegg, or be in a GitHub Action on domdomegg's repos
me.adamjones/my-cool-mcp you must prove ownership of adamjones.me via DNS or HTTP challenge

Community Projects

Check out community projects to explore notable registry-related work created by the community.

Install

claude_desktop_config.json

{
  "mcpServers": {
    "avalanche-docs": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://build.avax.network/api/mcp"
      ]
    }
  }
}

Desktop config is stdio-only; this bridges via mcp-remote. Native remote: Settings > Connectors.

docs_search

docs_fetch

docs_list_sections

cli_lookup_command

rpc_lookup_method

acp_lookup

acp_list

avalanche_docs_search

avalanche_docs_fetch

avalanche_docs_list_sections

blockchain_get_native_balance

blockchain_get_contract_info

blockchain_lookup_transaction

blockchain_lookup_address

blockchain_lookup_subnet

blockchain_lookup_chain

blockchain_lookup_validator

github_search_code

github_get_file

github_list_repositories

platform_get_height

platform_get_block

platform_get_block_by_height

platform_get_blockchains

platform_get_subnets

platform_get_current_validators

platform_get_pending_validators

platform_get_staking_asset_id

platform_get_min_stake

platform_get_total_stake

platform_get_balance

platform_get_utxos

platform_get_tx

platform_get_tx_status

platform_get_current_supply

platform_get_validators_at

info_get_node_version

info_get_network_id

info_get_network_name

info_get_blockchain_id

info_is_bootstrapped

info_get_tx_fee

info_peers

info_acps

MCP Registry

Development Status

Contributing

Quick start:

Pre-requisites

Running the server

Publishing a server

Other commands

Architecture

Project Structure

Authentication

Community Projects

More documentation

Install