# AI Toolkit ## Overview The **AI Toolkit** is a standardized collection of AI agents, skills, and commands designed for Claude Code workflows. Its goal is to allow anyone at Uniswap to enhance Claude Code with powerful plugins via the **Claude Code Marketplace**. **What it provides:** - **Plugin Marketplace**: Install curated plugins that bundle agents, skills, commands, and MCP servers - **Pre-built AI Agents**: Specialized subagents for code explanation, refactoring, testing, research, and more. Claude Code will use these automatically without any need for manual direction by the user - **Ready-to-use Skills & Commands**: Quick access patterns (called "[Slash commands](https://docs.anthropic.com/en/docs/claude-code/slash-commands)") for common development workflows like reviewing PRs (`/review-pr`), generating tests (`/generate-tests`), and planning features (`/plan-implementation`) - **MCP Server Integrations**: Pre-configured MCP servers for Linear, Notion, Graphite, and more - **Standardized Patterns**: Create a common toolset of Claude Code commands and agents shared by everyone at Uniswap **Why it exists:** Instead of each person at Uniswap manually configuring AI assistant behaviors for each project, the AI Toolkit provides curated, tested plugins that can be installed via the Claude Code Marketplace. This makes AI-assisted development more consistent, efficient, and accessible to Uni teams. ## Getting Started Before working with this repository, ensure you have the following tools installed: - **Node.js 22+** and **Bun 1.3.12+** (`curl -fsSL https://bun.sh/install | bash`) ### Local Installation ```bash # Clone the repository git clone https://github.com/Uniswap/ai-toolkit cd ai-toolkit # Install all dependencies (also sets up git hooks automatically) bun install ``` ### Setup Claude Code Integration ### Option A: Install Plugins via Marketplace (Recommended) The AI Toolkit provides plugins through the Claude Code Marketplace. To install, open Claude Code and run: ```bash # Step 1: Add the Uniswap AI Toolkit marketplace /plugin marketplace add Uniswap/ai-toolkit # Step 2: Install the plugins you want /plugin install development-planning@uniswap-ai-toolkit /plugin install development-pr-workflow@uniswap-ai-toolkit /plugin install development-codebase-tools@uniswap-ai-toolkit /plugin install development-productivity@uniswap-ai-toolkit /plugin install uniswap-integrations@uniswap-ai-toolkit # Optional plugins /plugin install spec-workflow@uniswap-ai-toolkit /plugin install claude-setup@uniswap-ai-toolkit ``` > **Note**: These commands are run inside the Claude Code REPL (i.e. after running `claude` in your terminal), not in your shell directly. ### Option B: Install MCP Server Addons ```bash # Run the CLI to see available options bun run start # Install MCP server addons bunx nx generate @uniswap/ai-toolkit-nx-claude:addons ``` ### Verify Installation ```bash # Make sure you have Claude Code installed claude # this should open up the Claude Code REPL # View installed plugins and their capabilities > /plugins # Execute custom slash commands from installed plugins > /review-pr > /plan-implementation ``` Once installed, you'll have access to powerful Claude Code agents, skills, and commands that make development workflows more efficient and consistent. ### Available Plugins | Plugin | Description | | ------------------------------ | ---------------------------------------------------------------------------- | | **development-planning** | Implementation planning & execution workflows | | **development-pr-workflow** | PR management, review, & Graphite integration | | **development-codebase-tools** | Code exploration, refactoring & analysis | | **development-productivity** | Documentation, research, & prompt optimization | | **uniswap-integrations** | External service integrations (Linear, Notion, etc.) | | **spec-workflow** | Autonomous spec-driven development with multi-agent collaboration (optional) | | **claude-setup** | Interactive setup wizard for configuring repos with Claude Code (optional) | ## Contributing We welcome contributions from all developers! This project uses a **trunk-based development workflow** with automated publishing. Please read our [Contributing Guide](./docs/readmes/CONTRIBUTING.md) for detailed information about: - **Branch strategy** (`main` for stable, `next` for active development) - **Development workflow** and best practices - **Code quality standards** and testing requirements - **Automated publishing** to private `@uniswap/ai-toolkit-nx-claude` NPM registry ### Quick Start for Contributors 1. **Setup your environment**: ```bash git clone https://github.com/Uniswap/ai-toolkit cd ai-toolkit bun install # Sets up everything including git hooks ``` 2. **Install recommended tools**: - **Nx Console** for your IDE (VSCode, Cursor, or IntelliJ) - **MCP server** for AI assistance: ```bash claude mcp add nx-mcp npx nx-mcp@latest --scope user ``` 3. **Create your feature**: ```bash git checkout next git checkout -b feature/your-feature # Make changes, then create PR to 'next' branch ``` For complete contribution guidelines, see [CONTRIBUTING.md](./docs/readmes/CONTRIBUTING.md). ## Development Workflow This repository follows a structured development and release workflow: ### Branches - **`main`**: Stable, production-ready code (publishes with `@latest` tag) - **`next`**: Feature integration and testing (publishes with `@next` tag) - **`feature/*`**: Individual feature branches (not published) ### Package Versions Our packages are available in two release channels: ```bash # Install stable version (from main branch) npx @uniswap/ai-toolkit-nx-claude@latest # Install prerelease version (from next branch) npx @uniswap/ai-toolkit-nx-claude@next ``` ### Automated Features - **Automated Publishing**: Packages are automatically published when changes merge to `main` or `next` - **Version Management**: Conventional commits automatically determine version bumps - **Branch Synchronization**: `next` is automatically rebased onto `main` after stable releases - **Code Quality**: Pre-commit hooks ensure consistent formatting and linting ### Run tasks To build the library use: ```sh bunx nx build pkg1 ``` To run any task with Nx use: ```sh bunx nx ``` These targets are either [inferred automatically](https://nx.dev/concepts/inferred-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) or defined in the `project.json` or in the `nx` property of `package.json` files. [More about running tasks in the docs »](https://nx.dev/features/run-tasks?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) ### Versioning and releasing This is done automatically in the CI on pushes to `main`. Checkout the [ci-publish-packages.yml](.github/workflows/ci-publish-packages.yml) workflow file for more information. [Learn more about Nx release »](https://nx.dev/features/manage-releases?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) ### Keep TypeScript project references up to date Nx automatically updates TypeScript [project references](https://www.typescriptlang.org/docs/handbook/project-references.html) in `tsconfig.json` files to ensure they remain accurate based on your project dependencies (`import` or `require` statements). This sync is automatically done when running tasks such as `build` or `typecheck`, which require updated references to function correctly. To manually trigger the process to sync the project graph dependencies information to the TypeScript project references, run the following command: ```sh bunx nx sync ``` You can enforce that the TypeScript project references are always in the correct state when running in CI by adding a step to your CI job configuration that runs the following command: ```sh bunx nx sync:check ``` [Learn more about nx sync](https://nx.dev/reference/nx-commands#sync) ### Automated Package Publishing The repository uses sophisticated CI/CD automation for package publishing: #### Publishing Pipeline Our automated workflow (`.github/workflows/ci-publish-packages.yml`) handles: - **Dual-branch publishing**: - `main` → stable releases (`@latest` tag) - `next` → prerelease versions (`@next` tag) - **Intelligent versioning**: Conventional commits drive automatic version bumps - **Independent packages**: Each package versions independently based on changes - **NPMJS registry**: GitHub Actions CI publishes packages to a private npmjs registry #### How It Works 1. **Feature Development** (on `next` branch): ```bash git commit -m "feat: amazing new feature" git push origin next # Automatically publishes as 1.0.0-next.0 ``` 2. **Stable Release** (merged to `main`): ```bash # After testing on next, merge to main # Automatically publishes as 1.0.0 ``` 3. **Branch Synchronization**: - After `main` publishes, `next` automatically rebases - Keeps development branch current with stable changes - Conflicts create GitHub issues for manual resolution For technical details, see [DEVELOPMENT.md](./docs/readmes/DEVELOPMENT.md). ### Install Nx Console Nx Console is an editor extension that enriches your developer experience. It lets you run tasks, generate code, and improves code autocompletion in your IDE. It is available for VSCode and IntelliJ. [Install Nx Console »](https://nx.dev/getting-started/editor-setup?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) ### Useful Nx links Learn more: - [Learn more about this workspace setup](https://nx.dev/nx-api/js?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) - [Learn about Nx on CI](https://nx.dev/ci/intro/ci-with-nx?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) - [Releasing Packages with Nx release](https://nx.dev/features/manage-releases?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) - [What are Nx plugins?](https://nx.dev/concepts/nx-plugins?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects) And join the Nx community: - [Discord](https://go.nx.dev/community) - [Follow us on X](https://twitter.com/nxdevtools) or [LinkedIn](https://www.linkedin.com/company/nrwl) - [Our Youtube channel](https://www.youtube.com/@nxdevtools) - [Our blog](https://nx.dev/blog?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects)