内容
# uswds-mcp
**美国Web设计系统（USWDS）的非官方MCP服务器。**
`uswds-mcp`是一个独立的本地stdio [模型上下文协议](https://modelcontextprotocol.io/) 服务器，帮助AI编码工具和IDE使用USWDS组件、设计模式、页面模板、软件包、设计令牌和无障碍指导。
本项目**与美国通用服务管理局（GSA）、技术转型服务（TTS）或官方USWDS团队无关，不受其支持、赞助或维护**。
该软件包包括从公共USWDS源预构建的索引：
- [`uswds/uswds-site`](https://github.com/uswds/uswds-site)
- [`uswds/uswds`](https://github.com/uswds/uswds)
USWDS是GSA/TTS的官方项目。该软件包是用于处理公共USWDS材料的独立开发者工具。
## 功能
- 搜索USWDS文档和实现记录。
- 检索结构化的组件、模式、模板、令牌和软件包记录。
- 推荐USWDS页面和服务结构。
- 生成框架中立的USWDS HTML，并附带框架适配说明。
- 为Next.js、React/Vite、静态HTML、Rails和Drupal提供框架特定的集成配方。
- 验证常见的USWDS标记、无障碍和令牌使用问题。
- 验证项目设置风险，例如错误的软件包导入路径、缺少的脚本、CDN使用、复制的资产和全局CSS影响。
- 在`.agents/skills/uswds/SKILL.md`中包含一个Codex技能，用于代理工作流指导。
## 使用已发布的软件包
大多数MCP客户端可以直接运行已发布的软件包：
```sh
npx -y uswds-mcp
```
作为项目依赖项：
```sh
npm install uswds-mcp
```
已发布的软件包包含`data/records.json`，因此文档支持的工具在无需运行摄取步骤的情况下即可工作。
## 从源代码开发
```sh
npm install
npm run build
```
从上游USWDS存储库刷新捆绑索引：
```sh
npm run ingest
```
## MCP配置
将软件包与支持stdio服务器的MCP客户端一起使用：
```json
{
"mcpServers": {
"uswds": {
"command": "npx",
"args": ["-y", "uswds-mcp"]
}
}
}
```
注册表名称：
```text
io.github.bibekpdl/uswds-mcp
```
## AI工具和IDE设置
USWDS MCP使用标准stdio MCP传输，可由MCP兼容的AI工具和IDE使用。有关示例，请参阅[docs/CLIENTS.md](./docs/CLIENTS.md)，其中涵盖：
- Claude Desktop
- Claude Code
- Cursor
- 带有GitHub Copilot MCP支持的VS Code
- Windsurf Cascade
- 通用MCP客户端
[examples/](./examples)中也提供了示例配置。
有关框架特定的设置指南，请参阅[docs/INTEGRATION.md](./docs/INTEGRATION.md)。
有关工具的逐一使用指南，请参阅[docs/TOOLS.md](./docs/TOOLS.md)。
## 开发
```sh
npm run typecheck
npm test
npm run build
npm run dev
```
## 工具
- `search_uswds`
- `get_component`
- `get_pattern`
- `get_template`
- `recommend_uswds_structure`
- `generate_uswds_page`
- `validate_uswds_markup`
- `get_uswds_integration_recipe`
- `validate_uswds_project_setup`
## 资源
- `uswds://component/{slug}`
- `uswds://pattern/{slug}`
- `uswds://template/{slug}`
- `uswds://token/{category}`
- `uswds://package/{name}`
## 提示
- `build_agency_website`
- `build_service_page`
- `audit_uswds_page`
- `convert_page_to_uswds`
- `integrate_uswds_in_project`
## 许可证
MIT
有关USWDS属性、上游源链接和索引USWDS材料的许可说明，请参见[NOTICE.md](./NOTICE.md)。
