AI Configuration Setup

AI 配置设置

本项目的目标是：

1. 简化 AI 工具的 AI 配置（规则、命令和 MCP 服务）的管理
2. 让开发者能够通过单一事实来源维护 AI 配置
3. 为全局和项目专属设置提供简单的配置流程

工作原理

你只需使用一个配置目录来存放规则、命令和 MCP 服务配置。一个脚本会将配置同步到两种 AI 工具的正确位置。

⚠️ 本项目在 MacOS 上构建并经过测试。目前不支持 Windows 和 Linux，因为还需要额外的工作。

支持的 AI 工具 🛠️

AI 工具	配置	MCP 服务	项目范围	全局范围
Copilot	详情	🚧（Cursor 的）	❌	✅
Claude Code	详情	✅	❌	✅
Cursor	详情	✅	✅（符号链接）	❌

使用方法

1. 设置配置目录，并添加规则、命令和 MCP 服务配置。
2. 运行 scripts/setup --help 查看所有选项。你可以控制要设置哪些配置。
3. 使用适当的标志运行 scripts/setup，将 AI 配置同步到正确的位置。

如有需要，可以运行 scripts/reset 重置配置。这会移除所有符号链接和全局配置文件。通常不需要这样做，因为设置脚本是幂等的。

配置目录结构

你的配置目录（默认为 ~/ai_configs）应采用适合存放规则、命令和 MCP 服务配置的结构。运行 setup 脚本时，可以通过设置 AI_CONFIGS_DIR 环境变量来覆盖该目录。

~/ai_configs/
├── rules/                   # Directory containing rule files (.mdc)
│   ├── rule1.mdc
│   └── rule2.mdc
├── commands/                # Directory containing command files (.mdc)
│   ├── command1.mdc
│   └── command2.mdc
└── mcp-servers-config.json  # Configuration for MCP servers

请注意，规则和命令均以 .mdc 文件编写。scripts/setup 脚本会使用这些文件，为 AI 工具创建相应的配置文件。

.mdc 文件示例

---
description: JavaScript coding standards for the project
globs: ["*.js", "*.jsx", "*.ts", "*.tsx"]
alwaysApply: false
---

You are a helpful AI assistant for JavaScript programming tasks. Always focus on readability and maintainability.

尽管有些 AI 工具可能不会使用 .mdc 文件，我们仍会保留其内容（作为上下文），并将其复制为 .md 文件。

mcp-servers-config.json 示例

{
  "fetch": {
    "type": "stdio",
    "command": "uvx",
    "args": ["mcp-server-fetch"]
  }
}

AI 工具详情

Copilot 配置

• 全局规则：规则设置在 VSCode 的设置文件（~/Library/Application Support/Code/User/settings.json）中，位于 github.copilot.chat.codeGeneration.instructions 键下。

  • 用户的 settings.json 是 JSON5 文件，因此无法可靠地修改其中的值（例如使用 jq）。所以使用了一个_标记_系统，用来替换两个标记键之间的所有内容：

    "__AI_TOOL_COPILOT_START": true,
    "github.copilot.chat.codeGeneration.instructions": [{"text":"rule1 content"},{"text":"rule2 content"},],
    "__AI_TOOL_COPILOT_END": true,
    

• 全局命令：命令（.mdc 文件）会复制到 ~/Library/Application Support/Code/User/prompts，并使用 prompt.md 扩展名

• MCP 服务：目前尚未配置服务配置，但 VSCode 可以使用 Cursor 的 MCP 配置

Claude Code 配置

• 全局规则：规则（.mdc 文件）会合并到 ~/.claude/CLAUDE.md
• 全局命令：命令（.mdc 文件）会复制到 ~/.claude/commands/，并使用 .md 扩展名
• MCP 服务：服务配置（定义在 mcp-servers-config.json 中）会添加到 ~/.claude.json

Cursor 配置

• 基于项目的规则：规则目录会在你的项目中（基于 pwd）创建符号链接，指向 .cursor/rules/local/rules
• 基于项目的命令：命令目录会在你的项目中（基于 pwd）创建符号链接，指向 .cursor/rules/local/commands
• MCP 服务：服务配置（定义在 mcp-servers-config.json 中）会复制到 ~/.cursor/mcp.json

Cursor 的限制

Cursor 目前仅支持基于项目的规则，不支持全局规则。这意味着：

• 你必须在要使用规则和命令的每个项目目录中进行设置。
• 此工具会在项目目录中创建指向中央规则/命令目录的符号链接。
• 由于使用了符号链接，你对配置文件所做的更改会自动反映到项目中。

你可能需要在版本控制系统中全局忽略新增的本地 Cursor 规则：**/.cursor/rules/local/**。

幂等更新

scripts/setup 设计为幂等的，也就是说，你可以多次运行而不会出现问题。以下情况适合这样做：

• 你修改了配置目录中的规则或命令
• 你想将（基于项目的）配置应用到新的项目目录
• 你需要更新 MCP 服务配置

对于 Cursor 的基于项目的配置，由于规则和命令文件采用符号链接，你所做的更改会自动反映到项目中。无需重新运行设置脚本，这些更改即可生效。