# agentic-design-mobile-mcp

[![NPM version](https://img.shields.io/npm/v/agentic-design-mobile-mcp.svg?style=flat)](https://npmjs.com/package/agentic-design-mobile-mcp)
[![NPM downloads](http://img.shields.io/npm/dm/agentic-design-mobile-mcp.svg?style=flat)](https://npmjs.com/package/agentic-design-mobile-mcp)

基于 [Model Context Protocol](https://modelcontextprotocol.io/) 的 **stdio** 服务，为 **Agentic Design Mobile**（`@alipay/agentic-design-mobile`）提供**本地 Markdown** 形式的组件说明与示例代码，供 Cursor、Claude Desktop 等客户端通过 MCP 工具查询。

## 功能概览

- 传输方式：**标准输入输出（stdio）**，符合 MCP 规范，由宿主进程拉起子进程通信。
- 数据源：包内 `components/<组件名>/docs.md` 与 `examples.md`。
- 推荐调用顺序：先 **`get_component_list`** 取组件名与资源可用性，再按需调用 **`get_component_docs`** / **`get_component_examples`**。

## MCP 工具

| 工具名 | 说明 |
|--------|------|
| `get_component_list` | 列出全部组件；每项标明是否包含 `docs.md`、`examples.md`。返回 Markdown 列表 + JSON。 |
| `get_component_docs` | 参数：`component`（字符串，**大小写不敏感**）。返回该组件 `docs.md` 全文（用法、API、说明等，不含独立示例文件内容）。 |
| `get_component_examples` | 参数：`component`（同上）。返回该组件 `examples.md` 全文（示例与代码片段）。 |

组件目录下须至少存在 `docs.md` 或 `examples.md` 之一才会出现在列表中；若仅有其一，调用缺失的一类会报错。

## 安装

**从 npm 使用（推荐）**

```bash
pnpm add -D @agentar/agentic-design-mobile-mcp
# 或
npm install @agentar/agentic-design-mobile-mcp
```

## 在 Cursor 中配置

使用 **stdio**，将 `command` / `args` 指到本机 Node 与构建产物（路径请改为你的绝对路径）：

```json
{
  "mcpServers": {
    "agentic-design-mobile-mcp": {
      "command": "npx",
      "args": [
        "@agentar/agentic-design-mobile-mcp"
      ]
    }
  }
}
```

## LICENSE

ISC