Akeyless MCP插件

Akeyless MCP插件连接JetBrains IDE与Akeyless服务,允许用户直接在IDE中管理密钥、证书等资源。

  • by akeyless-community
  • Kotlin
  • 本地部署
  • 更新于
在 GitHub 查看 akeyless-community/akeyless-mcp-plugin

使用说明

JetBrains IDE的Akeyless MCP插件

此插件通过模型上下文协议(MCP)服务器将JetBrains IDE连接到Akeyless,允许您直接从IDE管理机密、密钥、证书和其他Akeyless资源。

特性

  • 连接到Akeyless MCP服务器:配置并连接到您的Akeyless MCP服务器实例
  • 浏览项目:在树视图中查看所有无Akeyless项目(机密、密钥、证书)
  • 物品详情:单击任何项目以查看其详细信息和元数据
  • 创建秘密:直接从IDE创建新密钥
  • 刷新:刷新项目列表以查看最新更改
  • 设置:配置MCP服务器命令、工作目录和Akeyless配置文件

安装

从源头构建

  1. 克隆此仓库

  2. 在IntelliJ IDEA中打开项目

  3. 使用包装器运行Gradle构建(推荐):

    ./gradlew buildPlugin
    

    或者,如果您更喜欢使用Gradle系统:

    gradle buildPlugin
    

    备注:该项目使用Gradle 8.5和a JDK 17 编译工具链。如果 ./gradlew 无法启动,因为默认Java太新(例如25),set org.gradle.java.home 在 gradle.properties 安装JDK 17或21(请参阅该文件中的注释)。

  4. 出版 前往JetBrains Marketplace:请参阅 发布.md 和 publish.env.example.

  5. 安装插件:

    • 首选 File > Settings > Plugins
    • 点击齿轮图标并选择 Install Plugin from Disk...
    • 从以下位置选择生成的插件ZIP文件 build/distributions/

开发设置

  1. 确保您拥有:

    • JDK 17或更高版本
    • IntelliJ IDEA 2023.2或更高版本
    • 等级7.5+
  2. 在沙盒IDE中运行插件:

    ./gradlew runIde
    

配置

  1. 首选 File > Settings > Tools > Akeyless MCP
  2. 配置以下内容:
    • 服务器命令:启动Akeyless MCP服务器的命令(例如。, npx -y @akeyless/cli-mcp)
    • 工作目录:MCP服务器进程的可选工作目录
    • 无孔轮廓:可选的Akeyless CLI配置文件名称(如果为空,则使用默认名称)
    • 自动连接:IDE启动时自动连接

用法

  1. 打开 无孔MCP 工具窗口(视图>工具窗口>Akeyless MCP)
  2. 如果启用了自动连接,插件将尝试自动连接
  3. 使用工具栏按钮:
    • 刷新:刷新项目列表
    • 创建密钥:创建新秘密
    • 配置:打开设置

MCP服务器设置

该插件使用stdio传输连接到无Akeyless MCP服务器。MCP服务器的配置应类似于在Cursor中设置的方式:

  • 服务器命令应启动MCP服务器进程(例如。, npx -y @akeyless/cli-mcp)
  • 服务器通过stdio上的JSON-RPC进行通信
  • 身份验证由Akeyless CLI处理(使用配置文件或环境变量)

需求

  • JetBrains IDE(IntelliJ IDEA、PyCharm、WebStorm等)2023.2或更高版本
  • 已安装并配置Akeyless CLI
  • Node.js(如果使用 npx 运行MCP服务器)

故障排除

连接问题

  • 验证MCP服务器命令是否正确
  • 检查是否安装并配置了Akeyless CLI
  • 确保Akeyless配置文件(如果指定)存在且有效
  • 检查IDE日志: Help > Show Log in Files

项目未加载

  • 验证您是否有权在Akeyless中列出项目
  • 检查MCP服务器是否正常运行
  • 尝试手动刷新项目列表

发展

项目结构

akeyless-mcp-plugin/
├── src/main/kotlin/com/akeyless/mcp/
│   ├── McpClient.kt              # MCP client implementation
│   ├── McpClientService.kt       # Application service for MCP client
│   ├── actions/                  # Action classes
│   ├── settings/                 # Settings UI and persistence
│   └── ui/                       # UI components
├── src/main/resources/
│   └── META-INF/
│       └── plugin.xml            # Plugin descriptor
└── build.gradle.kts             # Build configuration

许可证

此插件按原样提供,用于连接到Akeyless MCP服务器。

支持

关于以下问题:

  • 插件:在此存储库中打开一个问题
  • Akeyless MCP服务器:联系Akeyless支持或查看Akeyless文档
  • Akeyless命令行界面:参见 Akeyless CLI文档