### Installing MCP Server Dependencies

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-tokens.md

Bash commands for navigating to the server directory and installing the required dependencies.

```bash
cd mx-api/
npm install
```

--------------------------------

### Configuring MCP Server Using Local Node.js Installation

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README.md

JSON configuration example for setting up a MultiversX API MCP server using a local Node.js installation with path to the built server and environment variables.

```json
{
  "mcpServers": {
    "mx-api-network": {
      "command": "node",
      "args": [
        "{full/path/to/mcp/server}/build/mx-api-network.js"
      ],
      "env": {
        "DEFAULT_NETWORK": "devnet"
      }
    }
  }
}
```

--------------------------------

### Installing MCP Server Dependencies

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-network.md

Bash commands to navigate to the server directory and install the required dependencies.

```bash
cd mx-api/
npm install
```

--------------------------------

### Installing MCP Server Dependencies

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-index.md

Bash commands to navigate to the server directory and install the necessary dependencies for the MultiversX API server.

```bash
cd mx-api/
npm install
```

--------------------------------

### Local Installation Commands

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-contracts.md

Series of bash commands for cloning the repository, installing dependencies, and building the server locally.

```bash
git clone https://github.com/unievo/mcp.git
```

```bash
cd mx-api/
npm install
```

```bash
npm run build
```

--------------------------------

### Installing MCP Server Dependencies with NPM

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-essentials.md

Bash commands to navigate to the server directory and install the required dependencies using NPM.

```bash
cd mx-api/
npm install
```

--------------------------------

### Installing MCP Server Dependencies

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-transactions.md

Bash commands to navigate to the server directory and install the required NPM dependencies.

```bash
cd mx-api/
npm install
```

--------------------------------

### Installing Dependencies for MCP Server with NPM

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-accounts.md

Commands to navigate to the server directory and install the required dependencies using NPM. This prepares the environment for building the server.

```bash
cd mx-api/
npm install
```

--------------------------------

### Example Tool Usage

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-contracts.md

TypeScript examples showing how to use various tools including set_network, get_application, and get_account_deploys with different parameters and field specifications.

```typescript
// Using set_network tool
{
  "name": "set_network",
  "arguments": {
    "network": "mainnet"
  }
}

// Using get_application tool
{
  "name": "get_application",
  "arguments": {
    "address": "erd1qqqqqqqqqqqqqpgqd77fnev2sthnczp2lnfx0y5jdycynjfhzzgq6p3rax",
    "fields": ["contract", "owner", "balance"]
  }
}

// Using get_account_deploys tool
{
  "name": "get_account_deploys",
  "arguments": {
    "address": "erd1qqqqqqqqqqqqqpgqd77fnev2sthnczp2lnfx0y5jdycynjfhzzgq6p3rax",
    "fields": ["all"]
  }
}
```

--------------------------------

### Install Dependencies for MultiversX MCP Server

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-essentials.md

Commands to navigate into the MultiversX API server directory and install its Node.js dependencies using npm.

```bash
cd mx-api/
npm install
```

--------------------------------

### Installing MCP Server Dependencies

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README.md

Bash commands for navigating to the server directory and installing the required npm dependencies for the MultiversX API MCP server.

```bash
cd mx-api/
npm install
```

--------------------------------

### Installing Dependencies for MCP Server in Bash

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-collections.md

Bash commands to navigate to the server directory and install dependencies using npm.

```bash
cd mx-api/
npm install
```

--------------------------------

### Calling MCP Tools with TypeScript Examples

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-accounts.md

Examples of how to call different MCP tools like set_network, get_accounts, and get_account_details with their respective parameters. These demonstrate the typical request format for interacting with the MCP server.

```typescript
// Using set_network tool
{
  "name": "set_network",
  "arguments": {
    "network": "mainnet"
  }
}

// Using get_accounts tool
{
  "name": "get_accounts",
  "arguments": {
    "size": 10,
    "fields": ["address", "balance", "nonce"]
  }
}

// Using get_account_details tool
{
  "name": "get_account_details",
  "arguments": {
    "address": "erd1qqqqqqqqqqqqqpgqd77fnev2sthnczp2lnfx0y5jdycynjfhzzgq6p3rax",
    "fields": ["all"]
  }
}
```

--------------------------------

### Install Dependencies for Local MultiversX MCP Server

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-tokens.md

Instructions to navigate into the `mx-api/` server directory and install its Node.js dependencies using npm, a prerequisite for building and running the server locally.

```bash
cd mx-api/
npm install
```

--------------------------------

### Example MCP Client Calls to MultiversX API Tools

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-essentials.md

Demonstrates how to make various API calls to the MultiversX API Essentials server from an MCP-compatible client. Examples include setting the network, retrieving account details, account tokens, NFTs, and transactions, with specific fields selected.

```typescript
// Using set-network tool
{
  "name": "set-network",
  "arguments": {
    "network": "mainnet"
  }
}

// Using get-accounts tool
{
  "name": "get-accounts",
  "arguments": {
    "size": 10,
    "fields": ["address", "balance", "nonce"]
  }
}

// Using get-account-tokens tool
{
  "name": "get-account-tokens",
  "arguments": {
    "address": "erd1qqqqqqqqqqqqqpgqd77fnev2sthnczp2lnfx0y5jdycynjfhzzgq6p3rax",
    "fields": ["identifier", "name", "balance"]
  }
}

// Using get-nfts tool
{
  "name": "get-nfts",
  "arguments": {
    "collection": "MEDAL-ae074f",
    "size": 10,
    "fields": ["identifier", "name", "url"]
  }
}

// Using get-transactions tool
{
  "name": "get-transactions",
  "arguments": {
    "sender": "erd1qqqqqqqqqqqqqpgqd77fnev2sthnczp2lnfx0y5jdycynjfhzzgq6p3rax",
    "size": 10,
    "fields": ["txHash", "sender", "receiver", "value", "status"]
  }
}
```

--------------------------------

### Example Tool Usage in MCP Client

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-network.md

TypeScript examples demonstrating how to use the MultiversX API Network MCP server tools. Shows usage of set_network and get_network_stats tools.

```typescript
// Using set_network tool
{
  "name": "set_network",
  "arguments": {
    "network": "mainnet"
  }
}

// Using get_network_stats tool
{
  "name": "get_network_stats",
  "arguments": {}
}
```

--------------------------------

### Example Usage of MultiversX API Collections MCP Tools

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-collections.md

These examples demonstrate how to interact with the MultiversX API Collections MCP server using various tools. They show how to set the network, retrieve NFT collections, get details for a specific collection, and fetch information about a single NFT, including parameter usage like 'fields' and 'withOwner'.

```typescript
// Using set-network tool
{
  "name": "set-network",
  "arguments": {
    "network": "mainnet"
  }
}

// Using get-collections tool
{
  "name": "get-collections",
  "arguments": {
    "size": 10,
    "fields": ["collection", "name", "type", "ticker"]
  }
}

// Using get-collection tool
{
  "name": "get-collection",
  "arguments": {
    "collection": "MEDAL-ae074f",
    "fields": ["all"]
  }
}

// Using get-nft tool
{
  "name": "get-nft",
  "arguments": {
    "identifier": "MEDAL-ae074f-01",
    "withOwner": true,
    "fields": ["all"]
  }
}
```

--------------------------------

### Install Dependencies for Local MultiversX MCP Server

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README.md

After cloning the repository, navigate into the `mx-api/` directory and use `npm install` to download and set up all required Node.js project dependencies for the MultiversX MCP servers.

```bash
cd mx-api/
npm install
```

--------------------------------

### Configuring MCP Server with Local Node Installation

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-tokens.md

JSON configuration for setting up the MultiversX API Tokens MCP server using a local Node installation.

```json
{
  "mcpServers": {
    "mx-api-tokens": {
      "command": "node",
      "args": [
        "{full/path/to/mcp/server}/build/mx-api-tokens.js"
      ],
      "env": {
        "DEFAULT_NETWORK": "devnet"
      }
    }
  }
}
```

--------------------------------

### Installing dependencies for MCP server

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-roles.md

Bash commands to navigate to the server directory and install the required dependencies for the MultiversX API Roles MCP server.

```bash
cd mx-api/
npm install
```

--------------------------------

### Configure MCP Client for Local MultiversX API Server

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-essentials.md

Configuration snippet for an MCP client to use a locally installed MultiversX API Essentials server. This setup requires specifying the full path to the built server JavaScript file and allows setting a default network via an environment variable.

```json
{
  "mcpServers": {
    "mx-api-essentials": {
      "command": "node",
      "args": [
        "{full/path/to/mcp/server}/build/mx-api-essentials.js"
      ],
      "env": {
        "DEFAULT_NETWORK": "devnet"
      }
    }
  }
}
```

--------------------------------

### Configuring MCP Server with Local Node Installation in JSON

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-essentials.md

JSON configuration for setting up the MultiversX API Essentials MCP server using a local Node.js installation. This requires specifying the full path to the built server file.

```json
{
  "mcpServers": {
    "mx-api-essentials": {
      "command": "node",
      "args": [
        "{full/path/to/mcp/server}/build/mx-api-essentials.js"
      ],
      "env": {
        "DEFAULT_NETWORK": "devnet"
      }
    }
  }
}
```

--------------------------------

### Install Dependencies for Local MultiversX MCP Server

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-roles.md

Commands to navigate to the MultiversX API server directory and install its Node.js dependencies.

```bash
cd mx-api/
npm install
```

--------------------------------

### Install MultiversX MCP Server Dependencies

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-collections.md

These commands navigate into the MultiversX API server directory and install its required Node.js dependencies using npm, preparing it for local use.

```bash
cd mx-api/
npm install
```

--------------------------------

### Configuring MCP Server with Local Node Installation

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-network.md

JSON configuration for setting up the MultiversX API Network MCP server using a local Node.js installation.

```json
{
  "mcpServers": {
    "mx-api-network": {
      "command": "node",
      "args": [
        "{full/path/to/mcp/server}/build/mx-api-network.js"
      ],
      "env": {
        "DEFAULT_NETWORK": "devnet"
      }
    }
  }
}
```

--------------------------------

### Install Dependencies for Local MultiversX MCP Server

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-network.md

Commands to navigate into the MultiversX API server directory and install its Node.js dependencies using npm, preparing the server for building and local use.

```bash
cd mx-api/
npm install
```

--------------------------------

### Install Dependencies for Local MultiversX MCP Server

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-accounts.md

Commands to navigate into the MultiversX API server directory and install its Node.js dependencies using npm, preparing the server for building and local execution.

```bash
cd mx-api/
npm install
```

--------------------------------

### Using MultiversX API Tools in TypeScript

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-essentials.md

Example TypeScript code demonstrating how to use various MultiversX API tools including set_network, get_accounts, get_account_tokens, get_nfts, and get_transactions. Each example shows proper parameter formatting.

```typescript
// Using set_network tool
{
  "name": "set_network",
  "arguments": {
    "network": "mainnet"
  }
}

// Using get_accounts tool
{
  "name": "get_accounts",
  "arguments": {
    "size": 10,
    "fields": ["address", "balance", "nonce"]
  }
}

// Using get_account_tokens tool
{
  "name": "get_account_tokens",
  "arguments": {
    "address": "erd1qqqqqqqqqqqqqpgqd77fnev2sthnczp2lnfx0y5jdycynjfhzzgq6p3rax",
    "fields": ["identifier", "name", "balance"]
  }
}

// Using get_nfts tool
{
  "name": "get_nfts",
  "arguments": {
    "collection": "MEDAL-ae074f",
    "size": 10,
    "fields": ["identifier", "name", "url"]
  }
}

// Using get_transactions tool
{
  "name": "get_transactions",
  "arguments": {
    "sender": "erd1qqqqqqqqqqqqqpgqd77fnev2sthnczp2lnfx0y5jdycynjfhzzgq6p3rax",
    "size": 10,
    "fields": ["txHash", "sender", "receiver", "value", "status"]
  }
}
```

--------------------------------

### Install Dependencies for Local MultiversX MCP Server

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-contracts.md

Navigate to the `mx-api/` directory and install the necessary Node.js dependencies for the MultiversX API Contracts server using npm.

```bash
cd mx-api/
npm install
```

--------------------------------

### Example MCP Client Usage for MultiversX Network Tools

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-network.md

Examples demonstrating how to invoke the `set-network` and `get-network-stats` tools using an MCP-compatible client. It illustrates the JSON structure required for tool invocation, including how to pass arguments.

```json
{
  "name": "set-network",
  "arguments": {
    "network": "mainnet"
  }
}

{
  "name": "get-network-stats",
  "arguments": {}
}
```

--------------------------------

### Example Usage of MultiversX API Tokens MCP Server Tools

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-tokens.md

Demonstrates how to interact with the MultiversX API Tokens server using various tools like `set-network`, `get-tokens`, `get-token`, and `get-account-tokens`. These examples illustrate the structure for passing arguments, including the use of the `fields` parameter for selective data retrieval.

```json
// Using set-network tool
{
  "name": "set-network",
  "arguments": {
    "network": "mainnet"
  }
}

// Using get-tokens tool
{
  "name": "get-tokens",
  "arguments": {
    "from": 0,
    "size": 10,
    "type": "FungibleESDT",
    "fields": ["identifier", "name", "ticker", "price"]
  }
}

// Using get-token tool
{
  "name": "get-token",
  "arguments": {
    "identifier": "WEGLD-bd4d79",
    "fields": ["all"]
  }
}

// Using get-account-tokens tool
{
  "name": "get-account-tokens",
  "arguments": {
    "address": "erd1qqqqqqqqqqqqqpgqd77fnev2sthnczp2lnfx0y5jdycynjfhzzgq6p3rax",
    "fields": ["identifier", "name", "balance", "valueUsd"]
  }
}
```

--------------------------------

### Example MCP Tool Usage

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-transactions.md

TypeScript examples demonstrating how to use various MCP tools including set_network, get_transactions, get_account_transactions, and send_transaction. Shows the JSON structure for each tool call with parameters.

```typescript
// Using set_network tool
{
  "name": "set_network",
  "arguments": {
    "network": "mainnet"
  }
}

// Using get_transactions tool
{
  "name": "get_transactions",
  "arguments": {
    "from": 0,
    "size": 10,
    "fields": ["txHash", "sender", "receiver", "value", "status"]
  }
}

// Using get_account_transactions tool
{
  "name": "get_account_transactions",
  "arguments": {
    "address": "erd1qqqqqqqqqqqqqpgqd77fnev2sthnczp2lnfx0y5jdycynjfhzzgq6p3rax",
    "from": 0,
    "size": 10,
    "fields": ["all"]
  }
}

// Using send_transaction tool
{
  "name": "send_transaction",
  "arguments": {
    "chainId": "1",
    "data": "dGVzdA==",
    "gasLimit": 70000,
    "gasPrice": 1000000000,
    "nonce": 5,
    "receiver": "erd1qqqqqqqqqqqqqpgqd77fnev2sthnczp2lnfx0y5jdycynjfhzzgq6p3rax",
    "sender": "erd1spyavw0956vq68xj8y4tenjpq2wd5a9p2c6j8gsz7ztyrnpxrruqzu66jx",
    "signature": "ed25519signature",
    "value": "0",
    "version": 1
  }
}
```

--------------------------------

### Clone MultiversX MCP Server Repository

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-essentials.md

Command to clone the MultiversX Model Context Protocol (MCP) server repository from GitHub for local installation.

```bash
git clone https://github.com/unievo/mcp.git
```

--------------------------------

### Cloning the MCP Server Repository with Git

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-essentials.md

Bash command to clone the MCP server repository from GitHub. This is the first step when installing the server locally.

```bash
git clone https://github.com/unievo/mcp.git
```

--------------------------------

### Install Dependencies for Local MultiversX MCP Server

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-transactions.md

Commands to navigate into the MultiversX API server directory and install its Node.js dependencies using npm, a prerequisite for building and running locally.

```bash
cd mx-api/
npm install
```

--------------------------------

### Configuring MCP Server with Node for Local Installation

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-index.md

JSON configuration for setting up the MultiversX API Index MCP server using a local Node.js installation. This configuration requires specifying the full path to the built server JavaScript file.

```json
{
  "mcpServers": {
    "mx-api-index": {
      "command": "node",
      "args": [
        "{full/path/to/mcp/server}/build/mx-api-index.js"
      ],
      "env": {
        "DEFAULT_NETWORK": "devnet"
      }
    }
  }
}
```

--------------------------------

### Example MCP Client Calls for MultiversX API Accounts

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-accounts.md

Examples demonstrating how to interact with the MultiversX API Accounts server from an MCP-compatible client. These JSON payloads illustrate calls for setting the network, retrieving multiple accounts with specific fields, and fetching details for a single account.

```json
// Using set-network tool
{
  "name": "set-network",
  "arguments": {
    "network": "mainnet"
  }
}

// Using get-accounts tool
{
  "name": "get-accounts",
  "arguments": {
    "size": 10,
    "fields": ["address", "balance", "nonce"]
  }
}

// Using get-account-details tool
{
  "name": "get-account-details",
  "arguments": {
    "address": "erd1qqqqqqqqqqqqqpgqd77fnev2sthnczp2lnfx0y5jdycynjfhzzgq6p3rax",
    "fields": ["all"]
  }
}
```

--------------------------------

### Example Usage of MultiversX API Roles Server Tools

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-roles.md

Examples demonstrating how to interact with the MultiversX API Roles server using various tools like `set-network`, `get-account-collections-with-roles`, `get-account-tokens-with-roles`, and `get-token-with-roles` with a focus on `fields` parameter usage.

```typescript
// Using set-network tool
{
  "name": "set-network",
  "arguments": {
    "network": "mainnet"
  }
}

// Using get-account-collections-with-roles tool
{
  "name": "get-account-collections-with-roles",
  "arguments": {
    "address": "erd1qqqqqqqqqqqqqpgqd77fnev2sthnczp2lnfx0y5jdycynjfhzzgq6p3rax",
    "fields": ["collection", "name", "type", "canCreate", "canBurn"]
  }
}

// Using get-account-tokens-with-roles tool
{
  "name": "get-account-tokens-with-roles",
  "arguments": {
    "address": "erd1qqqqqqqqqqqqqpgqd77fnev2sthnczp2lnfx0y5jdycynjfhzzgq6p3rax",
    "fields": ["identifier", "name", "canMint", "canBurn"]
  }
}

// Using get-token-with-roles tool
{
  "name": "get-token-with-roles",
  "arguments": {
    "address": "erd1qqqqqqqqqqqqqpgqd77fnev2sthnczp2lnfx0y5jdycynjfhzzgq6p3rax",
    "identifier": "WEGLD-bd4d79",
    "fields": ["all"]
  }
}
```

--------------------------------

### Build MultiversX MCP Server

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-essentials.md

Command to build the MultiversX Model Context Protocol (MCP) server after installing its dependencies.

```bash
npm run build
```

--------------------------------

### Using MCP Tools in TypeScript

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-collections.md

TypeScript examples demonstrating the usage of various MCP tools including set_network, get_collections, get_collection, and get_nft. Each example shows the tool name and its arguments.

```typescript
// Using set_network tool
{
  "name": "set_network",
  "arguments": {
    "network": "mainnet"
  }
}

// Using get_collections tool
{
  "name": "get_collections",
  "arguments": {
    "size": 10,
    "fields": ["collection", "name", "type", "ticker"]
  }
}

// Using get_collection tool
{
  "name": "get_collection",
  "arguments": {
    "collection": "MEDAL-ae074f",
    "fields": ["all"]
  }
}

// Using get_nft tool
{
  "name": "get_nft",
  "arguments": {
    "identifier": "MEDAL-ae074f-01",
    "withOwner": true,
    "fields": ["all"]
  }
}
```

--------------------------------

### Example Usage of MultiversX API Contracts MCP Tools

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-contracts.md

These examples demonstrate how to interact with the MultiversX API Contracts server using an MCP-compatible client. They show how to set the network, retrieve application details by address with specific fields, and fetch account deploys.

```typescript
// Using set-network tool
{
  "name": "set-network",
  "arguments": {
    "network": "mainnet"
  }
}

// Using get-application tool
{
  "name": "get-application",
  "arguments": {
    "address": "erd1qqqqqqqqqqqqqpgqd77fnev2sthnczp2lnfx0y5jdycynjfhzzgq6p3rax",
    "fields": ["contract", "owner", "balance"]
  }
}

// Using get-account-deploys tool
{
  "name": "get-account-deploys",
  "arguments": {
    "address": "erd1qqqqqqqqqqqqqpgqd77fnev2sthnczp2lnfx0y5jdycynjfhzzgq6p3rax",
    "fields": ["all"]
  }
}
```

--------------------------------

### Configuring MCP Server with Local Installation in JSON

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-collections.md

JSON configuration for using the MCP server with local installation. It specifies the command, arguments, and environment variables for the mx-api-collections server.

```json
{
  "mcpServers": {
    "mx-api-collections": {
      "command": "node",
      "args": [
        "{full/path/to/mcp/server}/build/mx-api-collections.js"
      ],
      "env": {
        "DEFAULT_NETWORK": "devnet"
      }
    }
  }
}
```

--------------------------------

### Configuring MCP Server with Local Node Installation

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-transactions.md

JSON configuration for setting up the MCP server using a local Node.js installation. Requires specifying the full path to the built JavaScript file and environment variables.

```json
{
  "mcpServers": {
    "mx-api-transactions": {
      "command": "node",
      "args": [
        "{full/path/to/mcp/server}/build/mx-api-transactions.js"
      ],
      "env": {
        "DEFAULT_NETWORK": "devnet"
      }
    }
  }
}
```

--------------------------------

### Example MCP Client Calls for MultiversX API Tools

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-transactions.md

Illustrative examples of how to invoke various tools provided by the MultiversX API Transactions MCP server from an MCP-compatible client. Demonstrates `set-network`, `get-transactions`, `get-account-transactions`, and `send-transaction` with their respective arguments.

```typescript
// Using set-network tool
{
  "name": "set-network",
  "arguments": {
    "network": "mainnet"
  }
}

// Using get-transactions tool
{
  "name": "get-transactions",
  "arguments": {
    "from": 0,
    "size": 10,
    "fields": ["txHash", "sender", "receiver", "value", "status"]
  }
}

// Using get-account-transactions tool
{
  "name": "get-account-transactions",
  "arguments": {
    "address": "erd1qqqqqqqqqqqqqpgqd77fnev2sthnczp2lnfx0y5jdycynjfhzzgq6p3rax",
    "from": 0,
    "size": 10,
    "fields": ["all"]
  }
}

// Using send-transaction tool
{
  "name": "send-transaction",
  "arguments": {
    "chainId": "1",
    "data": "dGVzdA==",
    "gasLimit": 70000,
    "gasPrice": 1000000000,
    "nonce": 5,
    "receiver": "erd1qqqqqqqqqqqqqpgqd77fnev2sthnczp2lnfx0y5jdycynjfhzzgq6p3rax",
    "sender": "erd1spyavw0956vq68xj8y4tenjpq2wd5a9p2c6j8gsz7ztyrnpxrruqzu66jx",
    "signature": "ed25519signature",
    "value": "0",
    "version": 1
  }
}
```

--------------------------------

### Clone MultiversX MCP Server Repository

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-accounts.md

Command to clone the MultiversX Model Context Protocol (MCP) server repository from GitHub, which is the first step for a local installation.

```bash
git clone https://github.com/unievo/mcp.git
```

--------------------------------

### Clone MultiversX MCP Server Repository

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-network.md

Command to clone the MultiversX Model Context Protocol (MCP) server repository from GitHub, which is the first step for a local installation.

```bash
git clone https://github.com/unievo/mcp.git
```

--------------------------------

### Using MCP tools with MultiversX API Roles server in TypeScript

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-roles.md

Example TypeScript code demonstrating how to use various tools provided by the MultiversX API Roles MCP server, including setting network, getting account collections with roles, getting account tokens with roles, and getting token with roles.

```typescript
// Using set_network tool
{
  "name": "set_network",
  "arguments": {
    "network": "mainnet"
  }
}

// Using get_account_collections_with_roles tool
{
  "name": "get_account_collections_with_roles",
  "arguments": {
    "address": "erd1qqqqqqqqqqqqqpgqd77fnev2sthnczp2lnfx0y5jdycynjfhzzgq6p3rax",
    "fields": ["collection", "name", "type", "canCreate", "canBurn"]
  }
}

// Using get_account_tokens_with_roles tool
{
  "name": "get_account_tokens_with_roles",
  "arguments": {
    "address": "erd1qqqqqqqqqqqqqpgqd77fnev2sthnczp2lnfx0y5jdycynjfhzzgq6p3rax",
    "fields": ["identifier", "name", "canMint", "canBurn"]
  }
}

// Using get_token_with_roles tool
{
  "name": "get_token_with_roles",
  "arguments": {
    "address": "erd1qqqqqqqqqqqqqpgqd77fnev2sthnczp2lnfx0y5jdycynjfhzzgq6p3rax",
    "identifier": "WEGLD-bd4d79",
    "fields": ["all"]
  }
}
```

--------------------------------

### Configure MCP Client for Local MultiversX API Transactions Server (Node)

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-transactions.md

Configuration snippet for MCP clients to integrate a locally installed MultiversX API Transactions server. This setup requires specifying the full path to the built server JavaScript file and allows setting a default network.

```json
{
  "mcpServers": {
    "mx-api-transactions": {
      "command": "node",
      "args": [
        "{full/path/to/mcp/server}/build/mx-api-transactions.js"
      ],
      "env": {
        "DEFAULT_NETWORK": "devnet"
      }
    }
  }
}
```

--------------------------------

### Configure MCP Client for Local MultiversX API Accounts Server (Node)

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-accounts.md

Configuration for an MCP client to use a locally installed MultiversX API Accounts server, specifying the direct path to the built JavaScript file. This setup also allows setting a default network via an environment variable.

```json
{
  "mcpServers": {
    "mx-api-accounts": {
      "command": "node",
      "args": [
        "{full/path/to/mcp/server}/build/mx-api-accounts.js"
      ],
      "env": {
        "DEFAULT_NETWORK": "devnet"
      }
    }
  }
}
```

--------------------------------

### Configure MCP Client for Local MultiversX API Network Server with Node

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-network.md

Configuration for an MCP client to use a locally installed MultiversX API Network server via Node.js. This setup requires specifying the full path to the server's build file and includes an optional environment variable for setting the default network.

```json
{
  "mcpServers": {
    "mx-api-network": {
      "command": "node",
      "args": [
        "{full/path/to/mcp/server}/build/mx-api-network.js"
      ],
      "env": {
        "DEFAULT_NETWORK": "devnet"
      }
    }
  }
}
```

--------------------------------

### Clone MultiversX MCP Server Repository

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-collections.md

This command clones the MultiversX Model Context Protocol (MCP) server repository from GitHub, which is the first step for a local installation.

```bash
git clone https://github.com/unievo/mcp.git
```

--------------------------------

### Build Local MultiversX MCP Server

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-tokens.md

Command to build the MultiversX Model Context Protocol (MCP) server after installing its dependencies, preparing it for local execution.

```bash
npm run build
```

--------------------------------

### Clone MultiversX MCP Server Repository

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-roles.md

Command to clone the MultiversX Model Context Protocol (MCP) server repository from GitHub for local installation.

```bash
git clone https://github.com/unievo/mcp.git
```

--------------------------------

### Clone MultiversX MCP Server Repository

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-transactions.md

Command to clone the MultiversX Model Context Protocol (MCP) server repository from GitHub for local installation.

```bash
git clone https://github.com/unievo/mcp.git
```

--------------------------------

### Build Local MultiversX MCP Server

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-transactions.md

Command to build the MultiversX API server after installing dependencies, preparing the JavaScript files for local execution.

```bash
npm run build
```

--------------------------------

### Get About Information

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-network.md

Returns general information about the network and the API itself, including version details for various components. Fields can be specified to narrow down the information retrieved.

```APIDOC
get-about
  Description: Returns information about network and API
  Parameters:
    fields: Array of strings, fields to retrieve. Use "all" for all fields.
  Returns: Information about app version, network, cluster, version, indexer version, gateway version, and features.
```

--------------------------------

### Building the MCP Server

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-index.md

Bash command to build the MultiversX API server from source code.

```bash
npm run build
```

--------------------------------

### Building the MCP Server with NPM

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-essentials.md

Bash command to build the MCP server from source code using NPM.

```bash
npm run build
```

--------------------------------

### Building the MCP Server

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-tokens.md

Bash command for building the MultiversX API Tokens MCP server.

```bash
npm run build
```

--------------------------------

### Building the MCP Server

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README.md

Bash command for building the MultiversX API MCP server from source code.

```bash
npm run build
```

--------------------------------

### Building the MCP Server

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-network.md

Bash command to build the MultiversX API Network MCP server.

```bash
npm run build
```

--------------------------------

### Building the MCP Server with NPM

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-accounts.md

Command to build the MultiversX API Accounts MCP server from source using NPM. This compiles the source code into executable JavaScript.

```bash
npm run build
```

--------------------------------

### Cloning the MCP Server Repository with Bash

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-accounts.md

Command to clone the MCP server repository from GitHub for local installation. This is the first step for setting up a local development environment.

```bash
git clone https://github.com/unievo/mcp.git
```

--------------------------------

### Describing Index and Essentials MCP Servers in Markdown

Source: https://github.com/unievo/mcp.git/blob/main/README.md

This snippet introduces the Index MCP server, which contains all tools from specialized servers, and the Essentials MCP server, which provides a reduced version with essential tools across multiple domains.

```markdown
- [Index](servers/mx-api/README-index.md) : Includes all tools

- [Essentials](servers/mx-api/README-essentials.md) : Includes essential tools across multiple domains
```

--------------------------------

### MultiversX API Tool: set-network

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-essentials.md

API documentation for the `set-network` tool, which allows configuring the MultiversX network for subsequent API calls.

```APIDOC
set-network
  Description: Set the MultiversX network to use
  Parameters:
    network: String
```

--------------------------------

### Get Token Transfers Count API

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-tokens.md

Returns the total number of transfers for a specific token. This endpoint supports filtering by sender, receiver, shard, miniblock hash, status, search terms, function name, and timestamps to get a precise count.

```APIDOC
Endpoint: get-token-transfers-count
Description: Returns the number of transfers for a specific token
Parameters:
  - identifier: string, Token identifier (required)
  - sender: string, Address of the transfer sender
  - receiver: string, Address of the transfer receiver
  - senderShard: string, Filter by sender shard
  - receiverShard: string, Filter by receiver shard
  - miniBlockHash: string, Filter by miniblock hash
  - status: string, Filter by transfer status
  - search: string, Search in transfer data
  - function: string, Filter by function name
  - before: timestamp, Before timestamp
  - after: timestamp, After timestamp
Returns: Count of transfers for the specified token
```

--------------------------------

### Using MultiversX API Tools in MCP Client

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-tokens.md

TypeScript examples showing how to use the various tools provided by the MultiversX API Tokens MCP server, including network configuration and token retrieval operations.

```typescript
// Using set_network tool
{
  "name": "set_network",
  "arguments": {
    "network": "mainnet"
  }
}

// Using get_tokens tool
{
  "name": "get_tokens",
  "arguments": {
    "from": 0,
    "size": 10,
    "type": "FungibleESDT",
    "fields": ["identifier", "name", "ticker", "price"]
  }
}

// Using get_token tool
{
  "name": "get_token",
  "arguments": {
    "identifier": "WEGLD-bd4d79",
    "fields": ["all"]
  }
}

// Using get_account_tokens tool
{
  "name": "get_account_tokens",
  "arguments": {
    "address": "erd1qqqqqqqqqqqqqpgqd77fnev2sthnczp2lnfx0y5jdycynjfhzzgq6p3rax",
    "fields": ["identifier", "name", "balance", "valueUsd"]
  }
}
```

--------------------------------

### Cloning the MCP Server Repository

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-index.md

Bash command to clone the MultiversX MCP server repository from GitHub to your local machine.

```bash
git clone https://github.com/unievo/mcp.git
```

--------------------------------

### Get All Blockchain Tokens

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-tokens.md

Returns all tokens available on the blockchain.

```APIDOC
get-tokens
  Description: Returns all tokens available on the blockchain
  Parameters:
    from: Number of items to skip for the result set
    size: Number of items to retrieve
    type: Token type ("FungibleESDT" | "NonFungibleESDT" | "SemiFungibleESDT" | "MetaESDT")
    search: Search by collection identifier
    name: Search by token name
    identifier: Search by token identifier
    identifiers: Array of strings, search by multiple token identifiers
    sort: Sorting criteria ("accounts" | "transactions" | "price" | "marketCap")
    order: Sorting order ("asc" | "desc")
    includeMetaESDT: Include MetaESDTs in response
    mexPairType: Array of strings, token Mex Pair types
    priceSource: Token Price Source ("dataApi" | "customUrl")
    fields: Array of strings, fields to retrieve. Use "all" for all fields
  Returns: List of tokens with details such as identifier, name, ticker, price, supply, etc.
```

--------------------------------

### Get Transfers for a Specific Token

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-tokens.md

Returns transfers for a specific token.

```APIDOC
get-token-transfers
  Description: Returns transfers for a specific token
  Parameters:
    identifier: Token identifier (required)
    from: Number of items to skip for the result set
    size: Number of items to retrieve
    sender: Address of the transfer sender
    receiver: Address of the transfer receiver
    senderShard: Filter by sender shard
    receiverShard: Filter by receiver shard
    miniBlockHash: Filter by miniblock hash
```

--------------------------------

### Building the MCP Server

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-transactions.md

Bash command to build the MultiversX MCP server from source code.

```bash
npm run build
```

--------------------------------

### Get Specific Token Details

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-tokens.md

Returns the details of a specific token.

```APIDOC
get-token
  Description: Returns the details of a specific token
  Parameters:
    identifier: Token identifier (required)
    fields: Array of strings, fields to retrieve. Use "all" for all fields
  Returns: Detailed information about a specific token
```

--------------------------------

### MultiversX API MCP Servers Reference

Source: https://github.com/unievo/mcp.git/blob/main/README.md

Detailed reference for the MultiversX API Model Context Protocol (MCP) servers, outlining supported networks, specialized server domains, and aggregated server types for AI agent interaction with the MultiversX blockchain.

```APIDOC
MultiversX API MCP Servers:
  Description: Servers enabling AI agents to read from and interact with the MultiversX blockchain API.

  Supported Networks:
    - Mainnet
    - Testnet
    - Devnet
    - Vibechain (VibeOX)
    - Configurable for any other network (via servers/mx-api/src/config.ts)

  Specialized MCP Servers:
    - Accounts: Account-related operations
    - Collections: NFT/SFT collections
    - Contracts: Smart contracts
    - Network: Network-related information
    - Roles: Account roles for collections and tokens
    - Tokens: Fungible tokens
    - Transactions: Blockchain transactions and transfers

  Aggregated MCP Servers:
    - Index: Includes all tools from specialized servers.
    - Essentials: Provides a reduced version of the full index server, focusing on essential tools across multiple domains.

  Custom Servers:
    - Possibility to construct custom MCP servers with any combination of tools.
```

--------------------------------

### Get Total Token Count

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-tokens.md

Returns the total number of tokens.

```APIDOC
get-tokens-count
  Description: Returns the total number of tokens
  Parameters:
    type: Token type ("FungibleESDT" | "NonFungibleESDT" | "SemiFungibleESDT" | "MetaESDT")
    search: Search by collection identifier
    name: Search by token name
    identifier: Search by token identifier
  Returns: Count of tokens matching the criteria
```

--------------------------------

### Get Transactions for a Specific Token

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-tokens.md

Returns a list of transactions for a specific token.

```APIDOC
get-token-transactions
  Description: Returns a list of transactions for a specific token
  Parameters:
    identifier: Token identifier (required)
    from: Number of items to skip for the result set
    size: Number of items to retrieve
    sender: Address of the transaction sender
    receiver: Address of the transaction receiver
    senderShard: Filter by sender shard
    receiverShard: Filter by receiver shard
    miniBlockHash: Filter by miniblock hash
    hashes: Array of strings, filter by transaction hashes
    status: Filter by transaction status
    function: Filter by function name
    before: Filter by timestamp (transactions before the given timestamp)
    after: Filter by timestamp (transactions after the given timestamp)
    order: Sort order ("asc" | "desc")
    withScResults: Include smart contract results in response
    withOperations: Include operations in response
    withLogs: Include logs in response
    fields: Array of strings, fields to retrieve. Use "all" for all fields
  Returns: List of transactions for the specified token
```

--------------------------------

### Listing Smart Contract API Endpoints in Markdown

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-index.md

API endpoints for interacting with smart contracts, including retrieving applications and their details.

```markdown
- `get_applications`: Get all applications (smart contracts)
- `get_applications_count`: Get count of applications (smart contracts)
- `get_application`: Get details for a specific application (smart contract)
```

--------------------------------

### Get Token Supply Metrics

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-tokens.md

Returns supply metrics for a specific token.

```APIDOC
get-token-supply
  Description: Returns supply metrics for a specific token
  Parameters:
    identifier: Token identifier (required)
    fields: Array of strings, fields to retrieve. Use "all" for all fields
  Returns: Supply information including totalSupply, circulatingSupply, minted, burned, initialMinted
```

--------------------------------

### Get Count of Transactions for a Specific Token

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-tokens.md

Returns the number of transactions for a specific token.

```APIDOC
get-token-transactions-count
  Description: Returns the number of transactions for a specific token
  Parameters:
    identifier: Token identifier (required)
    sender: Address of the transaction sender
    receiver: Address of the transaction receiver
    senderShard: Filter by sender shard
    receiverShard: Filter by receiver shard
    miniBlockHash: Filter by miniblock hash
    status: Filter by transaction status
    search: Search in transaction data
    function: Filter by function name
    before: Before timestamp
    after: After timestamp
  Returns: Count of transactions for the specified token
```

--------------------------------

### Configuring MCP Server using NPX with Environment Variables

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README.md

JSON configuration example for setting up a MultiversX API MCP server (specifically the network server) using NPX. This configuration includes environment variable settings for the default network.

```json
{
  "mcpServers": {
    "mx-api-network": {
      "command": "npx",
      "args": [
        "-y",
        "@unievo/mcp-mx-api-network"
      ],
      "env": {
        "DEFAULT_NETWORK": "devnet"
      }
    }
  }
}
```

--------------------------------

### Get Accounts Holding a Specific Token

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-tokens.md

Returns a list of accounts that hold a specific token.

```APIDOC
get-token-accounts
  Description: Returns a list of accounts that hold a specific token
  Parameters:
    identifier: Token identifier (required)
    from: Number of items to skip for the result set
    size: Number of items to retrieve
    fields: Array of strings, fields to retrieve. Use "all" for all fields
  Returns: List of accounts holding the specified token
```

--------------------------------

### Cloning the MCP Server Repository

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README.md

Bash command for cloning the MultiversX API MCP server repository from GitHub to a local environment.

```bash
git clone https://github.com/unievo/mcp.git
```

--------------------------------

### Get Total Account Transaction Count

Source: https://github.com/unievo/mcp.git/blob/main/servers/mx-api/README-essentials.md

Returns the total number of transactions for a given address

```APIDOC
get-account-transactions-count:
  Description: Returns the total number of transactions for a given address
  Parameters:
    address: Account address (required)
    type: Token type ("FungibleESDT" | "MetaESDT")
    search: Search by collection identifier
    name: Search by token name
    identifier: Search by token identifier
    identifiers: A comma-separated list of identifiers to filter by
    includeMetaESDT: Include MetaESDTs in response
    Similar filtering options as get-account-transactions
```