Angreal MCP服务器
MCP(模型上下文协议)服务器,为AI助手提供发现功能,用于 真遗憾 项目。
概述
此服务器向MCP兼容客户端公开angreal的命令树结构,使AI助手能够:
- 发现您的angreal项目中的可用命令和任务
- 了解项目结构和能力
- 根据上下文建议适当的命令
先决条件
- 真遗憾 必须在PATH中安装并可用
- Rust工具链(用于从源代码构建)
安装
# Install from crates.io
cargo install angreal_mcp
# Or install from git (latest development version)
cargo install --git https://github.com/colliery-io/angreal-mcp用法
使用克劳德代码
在以下位置创建或更新您的Claude Code MCP配置文件 ~/.config/claude-code/mcp_servers.json:
{
"mcpServers": {
"angreal": {
"command": "angreal_mcp",
"args": [],
"env": {}
}
}
}使用克劳德桌面
添加到您的Claude Desktop配置中:
{
"mcpServers": {
"angreal": {
"command": "angreal_mcp",
"args": [],
"cwd": "/path/to/your/angreal/project"
}
}
}与Cline(VS代码)
添加到您的Cline配置:
{
"mcp": {
"servers": [
{
"name": "angreal",
"command": ["angreal_mcp"],
"cwd": "${workspaceFolder}"
}
]
}
}命令行测试
您可以直接通过命令行测试MCP服务器:
# List available tools
echo '{"jsonrpc": "2.0", "id": 1, "method": "tools/list"}' | angreal_mcp
# Get angreal command tree
echo '{"jsonrpc": "2.0", "id": 1, "method": "tools/call", "params": {"name": "angreal_tree", "arguments": {"format": "json"}}}' | angreal_mcp可用工具
angreal_check
检查当前目录是否为angreal项目,并获取包括可用命令在内的项目状态。
angreal_tree
获取项目中所有可用angreal命令和任务的结构化视图。
参数:
format(可选):输出格式-"json"(默认)或"human"
angreal_run
执行带有可选参数的angreal命令或任务。
参数:
command(必填):要执行的angreal命令/任务args(可选):其他参数和标志
代理使用指南
在angreal项目中工作时,使用这些工具进行智能命令发现和执行:
工具使用工作流程
- 从发现开始:使用
angreal_check验证项目状态和能力 - 探索命令:使用
angreal_tree查看具有丰富元数据的可用命令 - 智能执行:使用
angreal_run具有上下文感知的参数选择
最佳实践
- 始终检查
when_to_use和when_not_to_use指导来自angreal_tree - 使用参数建议(
recommended_when)为了获得更好的结果 - 执行命令前验证先决条件
- 让命令输出和退出代码指导成功验证
常见模式
- 设置工作流:在生成/测试命令之前运行setup/install命令
- 开发周期:在代码更改后使用测试命令,在部署前使用构建命令
- 参数选择:调试时使用详细标志,发布时使用生产标志
故障排除
- 如果MCP服务器不可用,请重新启动Claude Code以重新初始化
- 检查是否安装了angreal二进制文件,并且可以在PATH中访问
- 验证您是否在angreal项目目录中(包含.angreal/文件夹)
angreal MCP服务器提供增强的命令元数据,包括使用上下文、参数指导和智能分类,以实现更好的自动化决策。
发展
运行测试
此项目使用angreal作为其测试运行器:
# Run tests using angreal
angreal test项目结构
angreal_mcp/
├── src/
│ ├── main.rs # Main server loop
│ ├── mcp.rs # MCP protocol implementation
│ └── angreal.rs # Angreal integration
├── examples/ # Configuration examples
└── tests/ # Integration tests建筑
# Debug build
cargo build
# Release build
cargo build --release
许可证
该项目在MIT或Apache-2.0下获得双重许可。
