使用说明
@byrde/agent工具包
配置MCP服务器,并为任何AI编码客户端生成智能代理指令。在配置文件中声明您使用的工具,运行一个命令,您的AI客户端就会得到正确配置的MCP服务器 和 教它如何单独和一起使用这些工具的最佳实践说明。
一切都是项目范围内的。打开一个配置好的项目,你的AI就完全连接好了。打开另一个目录,什么也不会泄露。
用法
npx @byrde/agent-toolkit init [options]
| 选项 | 描述 |
|---|---|
--cwd <path> |
项目目录。默认为当前工作目录。 |
--client <target> |
AI客户端: cursor, claude-code, copilot, codex, gemini-cli。省略时以交互方式提示。 |
-v, --verbose |
启用调试输出。 |
第一次运行时,向导会引导您完成服务器选择并写入 .agent-toolkit.json。在后续运行中,它提供重新配置。完成后重新启动IDE。
故障排除
npx @byrde/agent-toolkit doctor [options]
| 选项 | 描述 |
|---|---|
--cwd <path> |
项目目录。默认为当前工作目录。 |
--client <target> |
AI客户端: cursor, claude-code, copilot, codex, gemini-cli. |
--json |
机器可读的JSON输出。 |
-v, --verbose |
启用调试输出。 |
验证已配置项目的身份验证、客户端配置和端到端MCP连接。
支持的服务器
| 服务器 | 传输 | 身份验证机制 |
|---|---|---|
| GitHub | npx | GITHUB_PERSONAL_ACCESS_TOKEN 通过 gh |
| 谷歌云平台 | npx | gcloud 应用程序默认凭据 |
| 地形 | Docker | TFE_TOKEN 或凭据文件 |
| 亚托西亚 | npx | OAuth(基于浏览器) |
支持的AI客户端
| 客户端 | MCP配置路径 | 指令格式 |
|---|---|---|
| 光标 | .cursor/mcp.json |
.cursor/rules/agent-toolkit.mdc |
| 克劳德代码 | .mcp.json |
CLAUDE.md (围栏部分) |
| 副驾驶 | .vscode/mcp.json |
.github/copilot-instructions.md (围栏) |
| 法典 | .codex/config.toml |
AGENTS.md (围栏部分) |
| 双子星命令行工具 | .gemini/settings.json |
GEMINI.md (围栏部分) |
Git子模块使用
为了在不发布到npm的情况下进行快速测试,请将工具包添加为子模块:
git submodule add <repo-url> .agent-toolkit
cd .agent-toolkit && npm install && cd ..
然后直接从源代码调用CLI:
.agent-toolkit/bin/agent-toolkit init --client cursor
.agent-toolkit/bin/agent-toolkit doctor
发展
npm工作空间monorepo。需要Node.js>=20。
npm install
npm run build
npm run typecheck
npm test