Docs

Main site

Installation Browser support Extend config MCP server
Validation Page speed testing Responsive design
Accordion Aspect Ratio Avatar Badge Banner Bento Grid Blockquote Breadcrumbs Button Callout Card Drawer Dropdown Link Modal Navbar Navblock Pagination Popover Progress Separator Tabs Timeline Toast Tooltip
Checkbox Datepicker File upload Form field Input Label OTP Radio Range Select Textarea Toggle
Header Footer
Accordion Auth Checkbox & Radio Content Drawers Features Modals Statistics & Metrics Teams
Address Contact number Currency symbol Date Emirates ID Name
Close
Home Documentation MCP server

MCP server

Connect AI coding assistants to the UAE Design System through the Model Context Protocol (MCP), so they build with the documented components, API and code instead of writing markup from memory.

Overview

The Model Context Protocol (MCP) is an open standard that lets AI applications call tools and read resources from external servers. The UAE Design System runs a public MCP server that gives any MCP client direct access to the design system’s documentation: all 57 web components, their complete API, code for four frameworks, UAE patterns such as the Emirates ID and address, setup and configuration guides, the design guidelines and the design tokens.

An assistant connected to the server looks components up instead of guessing. Every snippet it receives is either written in the server's maintained documentation or generated from it at build time against the component API.

Setting Value
Endpoint https://designsystem.gov.ae/mcp
Transport Streamable HTTP
Authentication None
Access Read-only: eight tools, five resources and three prompts
Server name AEGOV Design System, version 1.1.0
Frameworks html, react, vue, angular
Rate limit 120 requests a minute and 2,000 an hour for each IP address
The server only returns documentation and code. Every tool is read-only and idempotent. The server cannot read your files, change your project or run code on your machine. Your AI client decides what to do with the answers, so review its changes as you would any other code.

Add the server to your AI tool

Any client that supports remote MCP servers over Streamable HTTP can connect with the server address alone. Most clients that use a JSON configuration file accept an entry in this shape:

{
  "mcpServers": {
    "aegov": {
      "url": "https://designsystem.gov.ae/mcp"
    }
  }
}

Field names vary between clients. Some expect "type": "http" next to the url, and some use serverUrl instead of url. Check your client’s documentation for the exact key names. The server name, aegov here, is your choice: it is only the label your client shows.

Clients that only support local servers

If your client can only start local (stdio) servers, bridge it to the remote endpoint with the open-source mcp-remote package. This needs Node.js:

{
  "mcpServers": {
    "aegov": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://designsystem.gov.ae/mcp"]
    }
  }
}

Claude Code

Add the server from your terminal:

claude mcp add --transport http aegov https://designsystem.gov.ae/mcp

To share the server with everyone working on a repository, add --scope project. Claude Code then writes it to a .mcp.json file in the project root that you can commit:

{
  "mcpServers": {
    "aegov": {
      "type": "http",
      "url": "https://designsystem.gov.ae/mcp"
    }
  }
}

Run claude mcp list, or type /mcp inside a session, to check that the server is connected.

Claude Desktop and Claude on the web

Add the server as a custom connector:

  1. Open Settings and go to Connectors.
  2. Select Add custom connector.
  3. Enter a name, such as UAE Design System, and the URL https://designsystem.gov.ae/mcp.
  4. Select Add, then turn the connector on in the conversations where you need it.

Custom connectors depend on your Claude plan. On Team and Enterprise plans, an owner may need to add the connector for the organisation first.

Codex

Add the server with the Codex CLI:

codex mcp add aegov --url https://designsystem.gov.ae/mcp

Or add it to ~/.codex/config.toml yourself. For a single project, use .codex/config.toml in the project root instead; Codex only loads it for trusted projects.

[mcp_servers.aegov]
url = "https://designsystem.gov.ae/mcp"

The Codex CLI, the IDE extension and the desktop app share this configuration. Run codex mcp list, or type /mcp in the Codex terminal interface, to check the connection.

Because every tool on this server is read-only, you can let Codex call them without asking each time:

[mcp_servers.aegov]
url = "https://designsystem.gov.ae/mcp"
default_tools_approval_mode = "writes"

The writes mode only prompts for tools that are not marked read-only, so none of the design system tools need approval.

Cursor

Create .cursor/mcp.json in your project to share the server with your team, or ~/.cursor/mcp.json in your home folder to use it in every project:

{
  "mcpServers": {
    "aegov": {
      "url": "https://designsystem.gov.ae/mcp"
    }
  }
}

Open Cursor’s settings and check that the aegov server is listed under MCP with its tools turned on. The tools are available in Agent mode.

Check the connection

Ask your assistant something only the server can answer, and name the server in the request:

Use the AEGOV MCP server to list the form components in the UAE Design System.

The assistant should call aegov_search_components and return a list of aegov-* tags. If it answers without calling a tool, it is working from memory: check that the server is connected and turned on.

To test the endpoint itself, send a tools/list request from a terminal:

curl -X POST https://designsystem.gov.ae/mcp \
  -H "Content-Type: application/json" \
  -H "Accept: application/json, text/event-stream" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'

A working server responds with JSON that lists the eight tools described below.

Tools

The server offers eight tools. All of them are read-only. Start with aegov_search_components to find the right tag, pattern or guideline topic, then use the other tools to fetch only what you need. Responses are kept small by default, and when a response is trimmed it says which call returns the rest.

Tool What it returns Required Optional
aegov_search_components A ranked list of matching components, UAE patterns and design guideline topics, each with a one-line description. It understands everyday wording such as "date picker" or "alert", and says when the library has no component for something, such as a table, and what to use instead. Called with no arguments, it lists the whole library. — query, category, include_subcomponents
aegov_get_component Guidance, usage rules and working examples for one component in one framework, with the imports the examples need and the design guideline topics behind the rules. tag, framework sections, response_format
aegov_get_component_api The complete API of one component: every prop, event, method, slot and shadow part. No prose and no examples. tag include
aegov_get_examples Code examples for one component in one framework, without the documentation prose. tag, framework section
aegov_get_pattern A UAE pattern (Emirates ID, address, contact number, name, date or the dirham currency symbol) with its rules, formats and code in one framework. Called with no arguments, it lists the patterns. — slug, framework
aegov_get_guidelines The design guidelines as precise rules, by topic or by area. Called with no arguments, it lists every topic. — topic, group
aegov_get_setup Installation and configuration for a framework: npm install, CSS imports and their order, Tailwind CSS configuration and component registration. With guide, one of the cross-cutting guides instead. framework bundler, topic, guide
aegov_get_tokens One group of design tokens, such as a colour palette or the type scale, as Tailwind CSS theme variables. group —

Parameters

Parameter Used by Accepted values
tag All component tools A component tag, such as aegov-button. The aegov- prefix is optional, so button and AegovButton also work. An unknown tag returns the closest matching tags.
framework aegov_get_component, aegov_get_examples, aegov_get_pattern, aegov_get_setup html, react, vue or angular. There is no default.
query aegov_search_components What you need, in any wording: a tag, a name such as date picker, a purpose such as confirm before deleting, or a UAE field such as emirates id. Every word must match; when nothing matches every word, the closest partial matches are returned and labelled as such.
category aegov_search_components actions, content, disclosure, feedback, forms, layout, media, navigation, overlay or status.
include_subcomponents aegov_search_components true (default) or false. Subcomponents are tags that must sit inside a parent, such as aegov-select-option.
sections aegov_get_component An array of section slugs. Slugs differ for each component: call the tool once without sections to see them.
response_format aegov_get_component concise (default) returns the introduction and a few examples. detailed returns the whole page.
include aegov_get_component_api An array of props, events, methods, slots or parts. It filters the response and never truncates it.
section aegov_get_examples One section slug, to return only that section’s examples.
bundler aegov_get_setup vite, webpack, parcel, rollup, postcss-cli or cdn.
topic aegov_get_setup A topic slug, such as css-imports, events, methods, rtl, ssr, validation or troubleshooting.
guide aegov_get_setup validation-overview, validation-byo, browser-support, extending-the-configuration, utilities or design-guidelines. Serves that guide instead of the framework guide; combine with topic to narrow it.
slug aegov_get_pattern address, contact-number, currency-symbol, date, emirates-id-input or name.
topic aegov_get_guidelines A guideline topic slug, such as button-hierarchy, form-errors, type-scale or logical-properties. Call the tool without arguments to list them all.
group aegov_get_guidelines typography, colour, layout-and-spacing, content, actions, forms, iconography, imagery, accessibility or mobile-applications.
group aegov_get_tokens A colour palette (aeblack, aegold, aegreen, aered, camel, desert, fuchsia, indigo, pink, primary, primary-support, purple, seablue, secondary, secondary-support, slate, techblue or whitely) or a scale (breakpoint, font, text or transition).

Resources

Clients that support MCP resources can also read documentation directly by address. Not every client shows resources, but the tools above cover the same content.

Resource Contents
aegov://guidelines The rules to follow whenever generating UAE Design System markup. Read this before writing any code.
aegov://component/{tag} Full documentation for one component.
aegov://component/{tag}/{framework} Every code example for one component in one framework.
aegov://guide/{slug} A guide: installation, using-with-react, using-with-vue, using-with-angular, validation-overview, validation-byo, browser-support, extending-the-configuration, utilities or design-guidelines.
aegov://pattern/{slug} A UAE pattern with its HTML examples.

Clients that support completions suggest tags, frameworks, guides and patterns as you type a resource address, and suggest values such as the framework and bundler as you fill in a prompt’s arguments.

The server also sends instructions to the client when it connects. Clients that support server instructions, such as Codex, use them to decide when and how to call the tools.

Prompts

Prompts are ready-made instructions that start a task with the right steps and tools. Clients that support MCP prompts show them as commands, for example as slash commands in Claude Code.

Prompt What it does Arguments
setup-project Adds the design system to a new or existing project: packages, the CSS imports in the right order, component registration and a check that components render. framework (required), bundler
make-rtl Converts a page or component to Arabic, right to left: lang and dir, logical properties, icon mirroring, numbers and each component’s right-to-left behaviour. target, framework
test-accessibility Audits a page or component against WCAG 2.2 level AA in English and Arabic, and reports each finding with its fix. target, framework

Recommended workflow

The server is designed so that an assistant pays for detail only when it needs it:

  1. Read the guidelines. Load aegov://guidelines, or ask your assistant to follow them, before it writes any markup. For typography, colour, layout, content and other design rules, call aegov_get_guidelines.
  2. Find the component. Call aegov_search_components with a query such as date picker or a category such as forms. For UAE data such as an Emirates ID, an address or an amount in dirhams, use the pattern it returns with aegov_get_pattern.
  3. Set up the project once. Call aegov_get_setup the first time the design system is added to a project. Component code does not render without the CSS imports and registration it describes.
  4. Get the code. Use aegov_get_component for guidance with examples, aegov_get_examples for code only, and aegov_get_component_api to confirm a prop or event exists.
  5. Use the tokens. Call aegov_get_tokens when you need colour, type or breakpoint values, and prefer the matching Tailwind CSS utility classes over raw variables.

Example requests

Using the AEGOV MCP server, build a contact form in React with name, email
and message fields, required-field validation and a submit button.
Use the AEGOV MCP server to set up the UAE Design System in a new Vue
project that uses Vite.
Check the AEGOV MCP server for every event aegov-datepicker emits, then add
a handler that logs the selected date.
Using the AEGOV MCP server, add an Emirates ID field to this Angular
registration form, following the UAE pattern for entering and displaying it.

To start a whole task with a prompt, choose it from your client’s prompt or command list instead of typing a request, for example setup-project with framework set to react and bundler set to vite.

Tools that cannot use MCP

AI tools that cannot connect to an MCP server can read the same documentation as plain text, in the llms.txt format:

Address Contents
https://designsystem.gov.ae/llms.txt An index of every document, with a one-line description of each.
https://designsystem.gov.ae/llms-full.txt Every document in one file: the usage rules, guides, design guidelines, components and patterns.

Each entry in llms.txt links to one document in markdown, at https://designsystem.gov.ae/llms/{type}/{slug}.md, where {type} is components, guides or patterns. For example, /llms/components/aegov-button.md or /llms/patterns/emirates-id-input.md. The usage rules are at /llms/guidelines.md. A sub-component, such as aegov-tab, returns the page of the component it belongs to.

The code examples in these files are HTML. The MCP server is the only way to get the examples in React, Vue and Angular.

Troubleshooting

Problem What to do
The client cannot connect Check that the address is exactly https://designsystem.gov.ae/mcp. A corporate proxy or firewall may block the connection, so ask your network team to allow it.
The client only supports local servers Use the mcp-remote bridge shown in Clients that only support local servers.
The assistant ignores the server Name the server in your request, for example “use the AEGOV MCP server”, and check that its tools are turned on in your client.
A tool returns an unknown tag, section or group Use the values listed in the error message. An unknown tag returns the closest matches; an unknown guideline topic returns the closest topics; every other wrong argument returns the full list of valid values.
The generated code does not render Call aegov_get_setup for your framework and bundler, and check that the CSS imports are in the right order.
The server returns error 429 The rate limit for your IP address has been reached. Wait a minute and try again. On a shared network, other people’s requests count towards the same limit.

Use AI responsibly

The MCP server makes sure your assistant uses the published components, but it does not review the result. Read Using AI for guidance on using AI responsibly in design, development and image generation.

Using AI responsibly Back to Installation