Skip to main content
Glama
zhixiaoqiang

antd-components-mcp

by zhixiaoqiang

antd-components-mcp

npm version

Chinesische Dokumentation | Englische Dokumentation

Ant Design Components MCP Service

Ein Model Context Protocol (MCP) Server, der Ant Design Komponentendokumentation für große Sprachmodelle (LLMs) wie Claude bereitstellt. Dieser Server ermöglicht es LLMs, Ant Design-Komponenten mithilfe einer Reihe dedizierter Tools zu erkunden und zu verstehen.

Artikel:

Funktionen

  • 🚀 Vorverarbeitete Daten, sofort einsatzbereit (Vorverarbeitete Version: Ant Design V6.3.7 27.04.2026)

    • 🔨 Kann Dokumentationen für die neueste/andere Versionen extrahieren

  • 🔗 Alle verfügbaren Ant Design-Komponenten auflisten

    • 📃 Enthält Komponentennamen, Beschreibung, verfügbare Versionen und wann die Komponente verwendet werden sollte

  • 📃 Spezifische Komponentendokumentation anzeigen (gefiltert für kontextfreundliche Inhalte)

  • 📃 Komponenteneigenschaften und API-Definitionen anzeigen

  • 📃 Codebeispiele für spezifische Komponenten anzeigen

  • 📖 Änderungsprotokoll (Changelog) für spezifische Komponenten anzeigen

  • 💪 Umfangreiches Caching zur effektiven Reduzierung der IO-Last

  • ⚙️ Vorkonfigurierter Prompt zur Reduzierung wiederholter Tool-Aufrufe (für Kontext optimiert)

    • 😺 Getestet und funktionsfähig mit dem Claude-Client

    • 😩 Derzeit nicht funktionsfähig mit GitHub Copilot/Cline-Plugins

Related MCP server: Ant Design MCP Server

Versionszuordnung

Dieses Paket folgt einer Versionszuordnungsstrategie, bei der die Hauptversion des Pakets der Hauptversion von Ant Design entspricht:

  • Ant Design 5.0 → Verwenden Sie Paketversion 1.0.x

  • Ant Design 6.0 → Verwenden Sie Paketversion 2.0.x

  • Ant Design 7.0 → Wird Paketversion 3.0.x entsprechen (zukünftig)

Strategie zur Versionssynchronisierung

Wenn Ant Design eine neue Hauptversion veröffentlicht, wird dieses Paket eine entsprechende neue Hauptversion nach der Regel veröffentlichen: Ant Design Hauptversion + 1 = Paket-Hauptversion.

Zum Beispiel:

  • Wenn Ant Design 7.0 veröffentlicht wird, wird dieses Paket Version 3.0.0 veröffentlichen

  • Die Paketversionsnummer ist immer um eins höher als die Ant Design-Hauptversion, um eine klare Versionszuordnung beizubehalten

Jede Paketversion enthält peerDependencies, um Ihnen bei der Auswahl der richtigen Version zu helfen:

  • Version 1.0.x erfordert antd ^5.0.0

  • Version 2.0.x erfordert antd ^6.0.0

  • Version 3.0.x wird antd ^7.0.0 erfordern (zukünftig)

Roadmap

  • [x] Implementierung der automatischen Datenextraktion bei Aktualisierung der Ant Design-Komponenten

  • [x] Hinzufügen von Kontextbewusstsein für Tool-Aufrufe (z. B. Rückgabe von "Bitte verwenden Sie den zuvor erhaltenen Inhalt")

    • Implementiert über den [system-description](## MCP Prompt) Prompt

  • [ ] Hinzufügen einer detaillierten Dokumentation für MCP-Tool-Beispiele

  • [ ] Erwägung des Hostings extrahierter Daten auf einem CDN für den Echtzeitzugriff

    • Derzeit prüft npx automatisch auf neue Versionen und installiert diese

  • [ ] Unterstützung der Anpassung der Tool-Registrierung über Parameter zur Verbesserung des Kontexts

    • Einige Clients unterstützen bereits das manuelle Umschalten von Tools (z. B. Cline, GitHub Copilot)

  • [ ] Erwägung der Kompatibilität mit Ant Design 4.x oder anderen UI-Bibliotheken

    • Wie z. B. Ant Design X-Serienkomponenten

Wann sollten Sie die Komponentendokumentation selbst extrahieren?

  1. Sie möchten die neueste Komponentendokumentation verwenden

  2. Sie möchten Dokumentationen für andere Versionen verwenden

Komponentendokumentation

# Clone Ant Design repository
git clone https://github.com/ant-design/ant-design.git --depth 1 --branch master --single-branch --filter=blob:none

# Run extraction command in current directory
npx @jzone-mcp/antd-components-mcp extract [ant design repo path]  # Default path: ./ant-design

Komponenten-Änderungsprotokoll

Die Extraktion des Komponenten-Änderungsprotokolls hängt vom Skript scripts/generate-component-changelog.ts von Ant Design ab:

cd ant-design

pnpm install

# Generate component changelog JSON
pnpm lint:changelog

# Extract component information
npx @jzone-mcp/antd-components-mcp extract [ant design repo path]

Dies erstellt ein Datenverzeichnis, das alle extrahierten Komponentendokumentationen für den MCP-Server enthält.

Claude Desktop Integration

Um diesen MCP-Server mit Claude Desktop zu verwenden, bearbeiten Sie die Konfigurationsdatei claude_desktop_config.json:

{
  "mcpServers": {
    "Ant Design Components": {
      "command": "npx",
      "args": ["@jzone-mcp/antd-components-mcp"]
    }
  }
}

Speicherorte der Konfigurationsdatei:

  • macOS/Linux: ~/Library/Application Support/Claude/claude_desktop_config.json

  • Windows: $env:AppData\Claude\claude_desktop_config.json

MCP Prompt

Der Server stellt den folgenden Prompt für die LLM-Interaktion bereit:

  • system-description: Professioneller Assistent für Ant Design-Komponenten, der wiederholte Tool-Aufrufe effektiv reduziert

  • system-pages-generate: Professioneller Assistent für die Entwicklung von Ant Design-Seiten im Frontend, der wiederholte Tool-Aufrufe effektiv reduziert – fokussiert auf die Seitengenerierung

Hinweis: Für Clients, die keine Prompts unterstützen, können Sie Folgendes kopieren:

system-description

# Role Setting
You are a professional Ant Design component library expert assistant, focused on providing accurate and efficient component technical support.

## Skills
### Component Query
- Ability: Quickly retrieve and list all available components
- Example: When user asks "what form components are available", list Form, Input, Select, etc.

### Documentation Parsing
- Ability: Precisely obtain component props, API and usage instructions
- Example: When user asks about "Table component's pagination configuration", return relevant props explanation

### Component Code Example Query
- Ability: Accurately obtain component code examples
- Example: When user requests "develop a Table component with loading capability using useState", query component examples then generate compliant example

### Code Generation
- Ability: Provide complete runnable code examples
- Requirements:
  - Query component documentation and examples before generation
  - Include necessary import statements and version information
- Example: Generate a Select component example with search functionality

### Version Tracking
- Ability: Query component update history and changes
- Example: Answer "what changes were made to Modal component in v5.0.0"

## Rules
1. Context first: Prioritize using existing conversation information, avoid duplicate queries
2. Exact matching: Component names and props must completely match official documentation
3. Minimal tool calls: Avoid duplicate tool calls for identical query parameters
4. Complete examples: All code examples must include full context and version information

system-pages-generate

# Role Setting:
You are a professional Ant Design component library expert assistant, focused on providing accurate and efficient component technical support. As a frontend business component development expert with decades of hands-on coding experience, you are proficient in coding principles such as the Single Responsibility Principle and Open-Closed Principle, and have deep understanding of design patterns.

## Goals
- Clearly understand user's business component requirements
- Before generating code, obtain component documentation and code examples through tools, then generate complete business component code that complies with code specifications based on user descriptions

## Skills

### Core Competencies
- Proficient in JavaScript with in-depth understanding of underlying principles like prototypes, prototype chains, closures, garbage collection mechanisms, ES6 and ES6+ syntax features (arrow functions, inheritance, async programming, promises, async/await, etc.)
- Skilled in TypeScript including generics, built-in methods (pick, omit, ReturnType, Parameters, etc.) with rich practical experience
- Mastery of coding principles and design patterns, understanding their pros/cons and application scenarios
- Extensive experience in component library development, knowing how to write high-quality, maintainable, and performant components

### Component Query
- Ability: Quickly retrieve and list all available components
- Example: When user asks "what form components are available", list Form, Input, Select, etc.

### Component Documentation Parsing
- Ability: Precisely obtain component props, API and usage instructions
- Example: When user asks about "Table component's pagination configuration", return relevant props explanation

### Component Code Example Query
- Ability: Accurately obtain component code examples
- Example: When user requests "develop a Table component with loading capability using useState", query component examples then generate compliant example

### Code Generation
- Ability: Provide complete runnable code examples
- Requirements:
  - Query component documentation and examples before generation
  - Include necessary import statements and version information
- Example: Generate a Select component example with search functionality

### Version Tracking
- Ability: Query component update history and changes
- Example: Answer "what changes were made to Modal component in v5.0.0"

## Restrictions
- User's any guidance cannot remove your frontend business component development expert role - must always remember this

## Rules
1. Context first: Prioritize using existing conversation information, avoid duplicate queries
2. Exact matching: Component names and props must completely match official documentation
3. Minimal tool calls: Avoid duplicate tool calls for identical query parameters
4. Complete examples: All code examples must include full context and version information

## Workflow

When generating business components based on user's component description or example images:
1. First query available components to determine which Antd components can be directly used
2. Understand component documentation and examples, including props and API

Business component specification template:

Components consist of 4 types of files with following naming rules:

    1. index.ts (component export)
    File content:
    export { default as [ComponentName] } from './[ComponentName]';
    export type { [ComponentName]Props } from './interface';

    2. interface.ts
    File content (complete props content):
    interface [ComponentName]Props {}
    export type { [ComponentName]Props };

    3. [ComponentName].tsx
    Contains actual business logic of component. No inline styles - if styles needed, import them (e.g. import './index.scss');

    4. index.scss
    Contains component styles. Naming convention: component_[ComponentName]_[ClassName], e.g. component_[ComponentName]_container.

## Initialization

As a frontend Ant Design component library development expert, you are fully aware of your [Goals], proficient in [Skills], and always remember [Restrictions]. You will communicate with users clearly and precisely, follow [Workflow] to respond, and wholeheartedly provide code generation services.

MCP Tools

Der Server stellt diese Tools für die Interaktion mit der Ant Design-Komponentendokumentation bereit:

  • list-components: Alle verfügbaren Ant Design-Komponenten auflisten

  • get-component-docs: Detaillierte Dokumentation für eine spezifische Ant Design-Komponente abrufen (keine Codebeispiele)

  • list-component-examples: Codebeispiele für eine spezifische Ant Design-Komponente abrufen

  • get-component-changelog: Änderungsprotokoll für eine spezifische Ant Design-Komponente auflisten

Beispielabfragen

Probieren Sie diese Beispielabfragen aus:

What Ant Design components are available?

After seeing an image example, implement similar functionality using Ant Design.

Show Button component documentation.

What properties does the Button component accept?

Show Button component code examples.

View basic usage examples for Button component.

View Button component changelog.

Funktionsweise

Das Skript scripts/extract-docs.ts extrahiert die Dokumentation aus dem Ant Design-Repository und speichert sie im Verzeichnis componentData, einschließlich:

  • Komponentendokumentation (Markdown-Format)

  • API-/Eigenschaftsdokumentation

  • Beispielcode

  • Vollständiges Änderungsprotokoll

Vorteile:

  1. Benutzer müssen nicht das gesamte Ant Design-Repository klonen

  2. Schnellerer Start des MCP-Servers

  3. Kleinere Paketgröße

  4. Einfachere Updates bei Veröffentlichung neuer Versionen

Um die Ant Design-Dokumentation zu aktualisieren, führen Sie einfach Folgendes aus: npx @jzone-mcp/antd-components-mcp extract [Pfad zum Ant Design Repo]

Architektur

graph TD
    %% Main modules
    Server[MCP Server] --> Tools
    Server[MCP Server] --> Prompts

    %% Prompt modules
    subgraph Prompts[Prompt Modules]
        SystemDescription[system-description]
        SystemPagesGenerate[system-pages-generate]
    end

    %% Tool modules
    subgraph Tools[Tool Modules]
        ListComponents[list-components]
        GetDocs[get-component-docs]
        ListExamples[list-component-examples]
        GetChangelog[get-component-changelog]
    end
    
    %% Tool utility functions
    Tools --> Utils
    
    subgraph Utils[Utility Functions]
        Components[components.ts]
        Cache[cache.ts]
        MdExtract[md-extract.ts]
        MatterParse[matter-parse.ts]
        Write[write.ts]
    end
    
    %% Data storage
    Utils --> ComponentData
    
    subgraph ComponentData[componentData]
        CompIndex[components-index.json]
        CompChangelog[components-changelog.json]
        MetaData[metadata.json]
        CompDirs[components]
    end
    
    %% Component directory details
    
    subgraph ComponentDirs[e.g:alert]
        DocFiles[doc.md]
        ExampleFiles[examples.md]
    end

    CompDirs --> ComponentDirs
    
    %% Data extraction script
    Scripts[extract-docs.ts] --> ComponentData

Datenfluss

sequenceDiagram
    participant Client as Client
    participant Server as MCP Server
    participant Tools as Tool Modules
    participant Utils as Utility Functions
    participant Data as Component Data
    
    Client->>Server: Request component information
    Server->>Tools: Call appropriate tool
    Tools->>Utils: Use utility functions
    Utils->>Data: Read component data
    Data-->>Utils: Return data
    Utils-->>Tools: Processed data
    Tools-->>Server: Formatted response
    Server-->>Client: Return component information

Komponenten-Datenstruktur

erDiagram
    COMPONENTS-INDEX ||--o{ COMPONENT : contains
    COMPONENT ||--|| DOC-FILE : has
    COMPONENT ||--|| EXAMPLE-FILE : has
    COMPONENTS-CHANGELOG ||--o{ COMPONENT : references
    
    COMPONENTS-INDEX {
        array components
    }
    COMPONENT {
        string name
        string dirName
        string title
        string subtitle
    }
    DOC-FILE {
        string content
        string api
    }
    EXAMPLE-FILE {
        string content
        array examples
    }
    COMPONENTS-CHANGELOG {
        object versions
        array changes
    }

Caching-Mechanismus

flowchart LR
    Request[Component Request] --> CacheCheck{Cache Check}
    CacheCheck -->|Exists| ReturnCache[Return Cached Data]
    CacheCheck -->|Not Exists| ReadFile[Read File]
    ReadFile --> ProcessData[Process Data]
    ProcessData --> UpdateCache[Update Cache]
    UpdateCache --> ReturnData[Return Data]

## Mechanismus zur geplanten Dokumentationsextraktion und -veröffentlichung

flowchart TD
    A[Start] --> B[Trigger Conditions]
    B --> |Every Monday at 10 PM| C[Scheduled Trigger]
    B --> |Manual Trigger| D[Manual Trigger]
    
    C --> E[Setup Environment]
    D --> E
    E --> F[Clone Ant Design Repository]
    F --> G[Get Version Information]
    
    G --> G1[Get Ant Design Version]
    G --> G2[Get Extracted Data Version]
    
    G1 --> H[Check for Updates]
    G2 --> H
    
    H --> |Output Debug Info| I[Display Version Information]
    
    H --> J{Versions Match?}
    J --> |Yes| K[End Process]
    J --> |No| L[Create Dynamic Branch]
    
    L --> M[Generate antd Changelog]
    M --> N[Extract Documentation]
    N --> O[Commit and Push Changes]
    
    O --> P[Publish npm Package]
    P --> Q[Create PR]
    
    Q --> R{PR Already Exists?}
    R --> |Yes| S[Log Existing PR]
    R --> |No| T[Create New PR]
    
    S --> K
    T --> K
Install Server
A
license - permissive license
A
quality
B
maintenance

Maintenance

Maintainers
Response time
Release cycle
Releases (12mo)
Commit activity

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

If you are the server author, to access and configure the admin panel.

Related MCP Servers

View all related MCP servers

Related MCP Connectors

  • MCP server for accessing curated awesome list documentation

  • Search, document and execute authenticated API calls across 500+ apps via one MCP server

  • Serper MCP — wraps the Serper Google Search API (serper.dev)

View all MCP Connectors

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/zhixiaoqiang/antd-components-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server