Project Structure

The codebase is organized into modular components:

src/
├── index.ts                # Main entry point
├── tools/                  # All tools organized by category
│   ├── common.ts           # Shared utilities and configs
│   ├── index.ts            # Tool registration
│   ├── accountAnalysis/    # Account analysis tools
│   ├── chainData/          # Chain data tools
│   ├── contractInteraction/# Contract interaction tools
│   ├── crossChain/         # Cross-chain tools
│   ├── development/        # Development tools
│   ├── batchOperations/    # Batch operation tools
│   └── stylus/             # Stylus development tools

Adding New Tools 🛠️

Arbitrum MCP Tools uses an active registration pattern – every tool is registered at runtime with server.tool(...). To add a new tool you need to:

1. Add the tool to its category’s registerXTools function

// src/tools/myCategory/index.ts
import { z } from "zod";
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";

export function registerMyCategoryTools(server: McpServer) {
  server.tool(
    "myNewTool", // unique name
    "Short description of what it does", // description
    {
      param1: z.string().describe("Example parameter"),
    },
    async ({ param1 }) => {
      // TOOL LOGIC ⤵️
      return {
        content: [{ type: "text", text: `You sent ${param1}` }],
      };
    }
  );
}

1. Hook the category into the global registry

Add (or update) the import in src/tools/index.ts and call the register function inside registerAllTools:

// src/tools/index.ts
import { registerMyCategoryTools } from "./myCategory/index.js";

export function registerAllTools(server: McpServer) {
  // …existing categories
  registerMyCategoryTools(server);
}

That’s it – when the MCP server starts, every registerXTools function runs and your new tool becomes available immediately.

---

Testing Your Tools 🧪

1. Build the project after making changes:

npm run build

1. Test your tools by selecting the local setup option for the following commands:

npm run setup-cursor | setup-windsurf | setup-claude | setup-gemini

1. If you're making significant changes, consider updating the setup scripts to ensure they handle your new tools correctly.

Contributing 🙌

Contributions are welcome! Please feel free to submit a Pull Request.

License 📜

This project is licensed under the MIT License - see the LICENSE file for details.