@clarified/mcp-server-aztec

An MCP (Model Context Protocol) server that provides seamless access to Aztec Protocol's codebase and documentation. This server enables AI assistants to efficiently search and retrieve code examples, type definitions, and documentation from the Aztec repository.

Introduction

The Aztec MCP server acts as a bridge between AI assistants and the Aztec Protocol codebase. It provides tools to:

• Search through TypeScript, Noir, and Solidity code
• Access documentation and examples
• Retrieve specific file contents
• Navigate the Aztec repository structure efficiently

Installation & Setup

GitHub Configuration

The server requires a GitHub personal access token with repo scope to access the Aztec repository. Set this token in your environment:

export GITHUB_TOKEN=your_token_here

Integration with AI Assistants

Claude Desktop App

1. Open the Claude configuration file:

   ~/Library/Application Support/Claude/claude_desktop_config.json

2. Add the Aztec MCP server configuration:

   {
     "mcpServers": {
       "aztec": {
         "command": "npx -y @clarified/mcp-server-aztec",
         "env": {
           "GITHUB_TOKEN": "your_token_here"
         },
         "disabled": false
       }
     }
   }

Cline

1. Open the Cline settings file:

   ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json

2. Add the Aztec MCP server configuration:

   {
     "mcpServers": {
       "aztec": {
         "command": "npx -y @clarified/mcp-server-aztec",
         "env": {
           "GITHUB_TOKEN": "your_token_here"
         },
         "disabled": false
       }
     }
   }

Features

Available Tools

1. Search Tool

Search for code or documentation in specific parts of the Aztec repository.

// Example usage
{
  "name": "search",
  "arguments": {
    "query": "interface TxRequest",
    "path": "yarn-project",
    "fileType": "ts"
  }
}

Parameters:

• query: Search query string
• path: Directory to search in
• fileType: Optional file type filter ("ts", "sol", "nr", "md")

2. Get Tool

Retrieve specific file contents from the Aztec repository.

// Example usage
{
  "name": "get",
  "arguments": {
    "path": "yarn-project/aztec-node/src/interfaces.ts"
  }
}

Parameters:

• path: Full path to the file

Supported Code Types

1. TypeScript (ts)

   • Location: yarn-project
   • Contains core TypeScript implementations

2. Noir (nr)

   • Locations:
     • noir-projects/aztec-nr
     • noir-projects/noir-contracts
   • Contains Noir circuit implementations

3. Solidity (sol)

   • Location: l1-contracts
   • Contains Ethereum smart contracts

4. Documentation (md)

   • Locations:
     • docs
     • README.md
   • Contains project documentation

API Reference

Search Tool Schema

{
  name: "search",
  description: "Search for code or documentation in the Aztec repository",
  inputSchema: {
    type: "object",
    properties: {
      query: {
        type: "string",
        description: "Search query"
      },
      path: {
        type: "string",
        description: "Directory path to search in"
      },
      fileType: {
        type: "string",
        enum: ["ts", "sol", "nr", "md"],
        description: "Optional file type filter"
      }
    },
    required: ["query", "path"]
  }
}

Get Tool Schema

{
  name: "get",
  description: "Get specific file content from the Aztec repository",
  inputSchema: {
    type: "object",
    properties: {
      path: {
        type: "string",
        description: "Full path to the file"
      }
    },
    required: ["path"]
  }
}