article
README
🚀 Firefly MCP 服务器
Firefly MCP(模型上下文协议)服务器是一款基于 TypeScript 的服务器,它能与 Firefly 平台实现无缝集成。借助该服务器,您可以在已连接到 Firefly 的云和 SaaS 账户中,轻松发现、管理并将资源编化。
🚀 快速开始
在开始使用 Firefly MCP 服务器之前,您需要满足一些先决条件,然后进行安装和配置,即可开启使用之旅。
✨ 主要特性
- 🔍 资源发现:可查找所有云和 SaaS 账户中的任何资源。
- 📝 资源编化:能将发现的资源转换为基础设施即代码(Infrastructure as Code)。
- 🔐 安全认证:使用 FIREFLY_ACCESS_KEY 和 FIREFLY_SECRET_KEY 进行安全通信。
- 🚀 易于集成:可与 Claude 和 Cursor 无缝协作。
📦 安装指南
先决条件
- Node.js (v14 或更高版本)
- npm 或 yarn
- 带有生成访问密钥的 Firefly 账户
安装命令
您可以直接使用 NPX 运行 Firefly MCP 服务器:
npx @fireflyai/firefly-mcp
环境变量
您可以通过以下两种方式提供您的 Firefly 凭据:
- 使用环境变量:
FIREFLY_ACCESS_KEY=your_access_key FIREFLY_SECRET_KEY=your_secret_key npx @fireflyai/firefly-mcp
- 使用命令行参数:
npx @fireflyai/firefly-mcp --access-key your_access_key --secret-key your_secret_key
💻 使用示例
标准输入输出
步骤 1:更新 mcp.json 文件
{
"mcpServers": {
"firefly": {
"command": "npx",
"args": ["-y", "@fireflyai/firefly-mcp"],
"env": {
"FIREFLY_ACCESS_KEY": "your_access_key",
"FIREFLY_SECRET_KEY": "your_secret_key"
}
}
}
}
步骤 2:运行 MCP 服务器
npx @fireflyai/firefly-mcp --sse --port 6001
步骤 3:再次更新 mcp.json 文件
{
"mcpServers": {
"firefly": {
"url": "http://localhost:6001/sse"
}
}
}
与 Cursor 结合使用
步骤 1:启动 MCP 服务器
使用上述安装部分提到的方法之一启动 MCP 服务器。
步骤 2:连接到 MCP 服务器
使用 Cursor 扩展连接到 MCP 服务器 - 参见 Cursor 模型上下文协议文档。
步骤 3:查询资源
使用自然语言查询您的资源。
示例:
提示
查找所有“ubuntu-prod”EC2 实例在 123456789012 AWS 账户中,并将其编化为 Terraform
响应
resource "aws_instance" "ubuntu-prod" {
ami = "ami-0c55b159cbfafe1f0"
instance_type = "t3.micro"
}
📚 详细文档
示例演示
您可以通过以下链接查看示例演示: https://github.com/user-attachments/assets/0986dff5-d433-4d82-9564-876b8215b61e
贡献
如果您想为该项目做出贡献,可以按照以下步骤进行:
- 叉存仓库
- 创建功能分支 (
git checkout -b feature/amazing-feature) - 提交更改 (
git commit -m 'feat: Add amazing feature') - 推送到分支 (
git push origin feature/amazing-feature) - 打开 Pull Request
支持
如需支持,请访问 Firefly 的文档 或在此仓库中创建问题。
📄 许可证
本项目根据 MIT License 分发 - 详细信息请参阅 LICENSE 文件。
微信扫一扫