home / skills / multiversx / mx-ai-skills / consult_mvx_docs

consult_mvx_docs skill

safe

This skill helps you access MultiversX documentation to verify implementation details and follow best practices across smart contracts and protocols.

npx playbooks add skill multiversx/mx-ai-skills --skill consult_mvx_docs

Review the files below or copy the command above to add this skill to your agents.

Files (1)

SKILL.md

3.2 KB

---
name: consult_mvx_docs
description: Access the global MultiversX documentation library to answer technical questions or verify implementation details.
---

# Consult MultiversX Documentation

You have access to a comprehensive library of MultiversX documentation, standards, and best practices stored in this repository at:
`antigravity/mvx_docs`

Note: Agents must resolve this path relative to the repository root (current workspace). If the agent runs outside this repo or without filesystem access, ensure the repo (including `antigravity/mvx_docs`) is mounted or provided in context.

## When to use this skill
- When you need to understand specific MultiversX protocols (ESDT, Smart Contracts, transactions).
- When you need to verify best practices for security, gas optimization, or architecture.
- When you need to look up details about a specific MIP (MultiversX Improvement Proposal).
- When you need to answer a user's question about the ecosystem using authoritative sources.

## How to use
Use standard file search tools to find relevant information within the documentation directory.

### 1. Find relevant files
Use `find_by_name`, `grep_search`, or your environment’s search to locate relevant documents.

```bash
# Example: Find docs related to ESDT tokens (repo-relative)
find_by_name(SearchDirectory="antigravity/mvx_docs", Pattern="*esdt*")
```

```bash
# Example: Search for "async call" inside the docs
grep_search(SearchPath="antigravity/mvx_docs", Query="async call")
```

### 2. Read content
Once you have identified relevant files, use `read_browser_url` (if it was a URL) or simply `view_file` to read the markdown content.

```bash
view_file(AbsolutePath="antigravity/mvx_docs/sc_async_calls.md")
```

### 3. Online fallback (if local docs unavailable)
If the local repository docs are not available in your runtime or appear outdated, consult the official MultiversX documentation site:

- Base URL: https://docs.multiversx.com/

Examples:
```bash
# Open a specific page
read_browser_url(URL="https://docs.multiversx.com/developers/sc-overview/")
```

Common direct links:
- Smart Contracts Overview: https://docs.multiversx.com/developers/smart-contracts
- sc-meta Tool: https://docs.multiversx.com/developers/meta/sc-meta
- Storage Mappers: https://docs.multiversx.com/developers/developer-reference/storage-mappers
- Annotations: https://docs.multiversx.com/developers/developer-reference/sc-annotations
- Payments: https://docs.multiversx.com/developers/developer-reference/sc-payments

Searching the docs site: The official site uses client-side search without a URL query parameter. To search, use an external search engine with a site filter, for example:

```text
site:docs.multiversx.com async call
site:docs.multiversx.com annotations payable
```

Note: Online access requires network permissions in your agent environment. Prefer local docs for reproducibility; use the official site (and site-filtered web search) when local docs are missing or stale.

## Best Practices
- Always verify your assumptions against these docs if you are unsure.
- Quote the documentation when explaining concepts to the user.
- If the docs seem outdated compared to the codebase you are working on, note that discrepancy to the user.

Overview

This skill provides direct access to a curated MultiversX documentation library to answer technical questions and verify implementation details. It helps developers find authoritative guidance on protocols, smart contracts, transactions, and platform best practices. Use it to reduce guesswork and align implementations with official recommendations.

How this skill works

The skill searches a repository-local docs folder (antigravity/mvx_docs) for relevant files, reads the markdown content, and returns concise, sourced answers. If local docs are unavailable or outdated, it can fall back to the official MultiversX docs site and site-filtered web search. Typical operations include file name search, text grep, and viewing specific document pages to extract precise details.

When to use it

Explaining MultiversX protocols such as ESDT, wallets, or transactions.
Verifying smart contract patterns, annotations, storage mappers, or payment handling.
Checking specific MultiversX Improvement Proposals (MIPs) or protocol changes.
Confirming gas optimization, security recommendations, or architecture guidelines.
Sourcing authoritative documentation citations for user-facing answers.

Best practices

Prefer the repository-local docs for reproducible, versioned answers; fall back to the official site only when needed.
Use exact filename or keyword searches (find_by_name, grep_search) to locate authoritative pages quickly.
Quote or link to the specific document and section when explaining behavior to users.
Flag and report any discrepancies between documentation and the live codebase or runtime behavior.
When online access is required, use site-scoped search queries (site:docs.multiversx.com) to find pages reliably.

Example use cases

Answer a developer question about ESDT token transfer semantics and reference the precise doc section.
Verify correct use of sc-annotations and storage mappers before code review or deployment.
Look up payment handling and payable annotations while implementing a smart contract function.
Confirm MIP details and implementation guidance when auditing protocol changes.
Locate gas optimization tips and recommended transaction patterns for dApp performance improvements.

FAQ

What if the local docs are missing or out of date?

First attempt an online fallback to the official MultiversX docs site. Note and communicate any discrepancies between local docs and the live site to the user.

How do I search for a specific topic inside the docs?

Use filename searches (find_by_name) and content searches (grep_search) within antigravity/mvx_docs. For the public site, use an external search engine with site:docs.multiversx.com and your query.