Back to Ant Design

For Agents

docs/react/for-agents.en-US.md

6.4.52.3 KB
Original Source

This page provides a ready-to-use prompt that lets any AI coding agent work with Ant Design effectively.

Copy this prompt

Copy into your agent conversation or automation runner.

text
Before writing any code, please read https://ant.design/docs/react/for-agents.md and https://raw.githubusercontent.com/ant-design/ant-design-cli/main/skills/antd/SKILL.md, pay attention to deprecation warnings, and follow the instructions to use Ant Design.

If you can install skills, run:
npx skills add ant-design/ant-design-cli

What the agent gets

CLI — offline knowledge and project tools

@ant-design/cli ships all metadata locally — every prop, token, demo, and changelog entry for antd v3 / v4 / v5 / v6 — queryable in milliseconds, fully offline.

bash
npm install -g @ant-design/cli
bash
antd info Button                    # Component props, types, defaults
antd demo Select basic              # Runnable demo source code
antd token DatePicker               # Design Token values (v5+)
antd semantic Table                 # classNames / styles structure
antd changelog 4.24.0 5.0.0 Select  # API diff across versions
antd doctor                         # Diagnose project issues
antd lint ./src                     # Check deprecated APIs & best practices
antd migrate 4 5 --apply ./src      # Agent-ready migration prompt

Full reference: CLI

MCP Server — IDE integration

The CLI also runs as an MCP server with 8 tools and 2 prompts for IDE integration (Claude Code, Cursor, VS Code, etc.).

json
{
  "mcpServers": {
    "antd": {
      "command": "npx",
      "args": ["-y", "@ant-design/cli", "mcp"]
    }
  }
}

Full reference: MCP Server

LLMs.txt — structured docs for LLMs

Feed complete component documentation directly into AI context:

FileDescription
llms.txtNavigation file with links to all docs and components
llms-full.txtFull component documentation (English)
llms-full-cn.txtFull component documentation (Chinese)

Single component docs are also available at https://ant.design/components/<name>.md.

Full reference: LLMs.txt