使用说明(Markdown 格式)

  • 项目简介
    • Secret MCP 将桌面应用与本地 MCP 服务器结合,帮助 AI 编码助手在本地环境中处理秘密,并通过两项 MCP 工具实现密钥读取与环境变量写入,同时确保密钥值不暴露给 AI。
  • 主要功能点
    • 本地秘密管理与存储:使用 SQLite 将密钥信息(名称、描述、值)本地化存储,密钥值不会暴露给 AI。
    • MCP 服务器核心功能:提供资源(Resources)、工具(Tools)以及提示模板(Prompts)的托管、读取和执行能力,通过 JSON-RPC 与客户端通信。
    • 工具集合
      • search_secrets:按名称/描述检索密钥名称与描述,返回结果中不包含密钥值。
      • write_env:将指定密钥写入本地 .env 文件,密钥值直接从本地数据库写入,未传输给 AI。
    • Prompts 渲染:支持自定义的 Prompt 模板,用于定义与 LLM 的交互模式。
    • 安全与本地性:密钥值从不离开本机,.env 文件写入时设置权限,保护密钥不被误用。
    • 技术栈与实现方式:桌面端使用 Tauri + Svelte + TypeScript;MCP 服务端使用 Node.js、@modelcontextprotocol/sdk、better-sqlite3,结合 AJV/Zod 等工具进行数据验证与结构定义。
  • 安装步骤
    • Desktop App
      • 直接从 Releases 下载,或按项目源代码构建:
        • npm install
        • npm run tauri build
    • MCP Server 启动
      • MCP 客户端配置示例(客户端需要该信息来启动服务器):
        • 命令行启动:npx secret-mcp
        • 运行参数:无额外参数或按需扩展(请参阅客户端配置示例)
      • 客户端读取到的基本启动信息通常包括:
        • serverName: Secret MCP
        • command: npx
        • args: ["secret-mcp"]
  • 服务器配置示例(供 MCP 客户端使用的配置,JSON 格式,含 serverName、command、args 等) { "serverName": "Secret MCP", "command": "npx", "args": ["secret-mcp"] } 注:上面的字段用于 MCP 客户端在本地创建与 Secret MCP 服务的连接和启动。客户端本身并不需要实现复杂逻辑,仅需按此格式提供启动信息即可。
  • 基本使用方法
    1. 打开 Secret MCP 桌面应用,录入并管理密钥(API_KEY、DATABASE_URL 等名-值对,值仅保存在本地)。
    2. 在 AI 编码时,直接让 AI 客户端通过 search_secrets 获取密钥名称与描述,用于搭建上下文,且不会暴露密钥值。
    3. 当需要将密钥写入环境变量文件时,调用 write_env,指定要写入的密钥名和目标路径,密钥值将由服务器写入文件,AI 不会看到实际密钥值。
    4. 如需自定义 Prompts,请在服务器端定义并渲染相应模板,便于对话与上下文推断。
  • 额外信息
    • MCP 客户端通过 JSON-RPC 与服务器通信,核心协议定义与请求/响应格式由 MCP 规范及其 SDK 提供的类型定义支撑。
    • 服务器启动后可与本地 AI 客户端对接,实现“本地上下文服务 + 安全密钥访问”的工作流。

信息

分类

桌面与硬件