article
README
🚀 Secret MCP
Secret MCP是一款桌面应用程序,用于与MCP服务器协同管理机密信息。它能让AI编码助手编写 .env 文件,同时确保机密值不被泄露。
🚀 快速开始
Secret MCP为开发者提供了一种安全且便捷的方式来管理和使用机密信息。通过与MCP服务器集成,AI编码助手可以在不接触机密值的情况下编写 .env 文件,有效避免了机密信息的泄露风险。
✨ 主要特性
- 桌面应用:提供一个简洁的窗口,用于管理机密信息(包括名称、描述和值)。
- MCP服务器:为AI助手提供两个工具:
search_secrets:按名称或描述搜索机密信息(绝不暴露值)。write_env:将机密信息写入.env文件(值直接写入文件,不会传输给AI)。
- 本地存储:所有机密信息都以SQLite数据库的形式本地存储。
- npm包:只需运行
npx secret-mcp即可,无需构建。
📦 安装指南
桌面应用
你可以从 发布页面 下载应用程序,也可以从源代码进行构建:
npm install
npm run tauri build
MCP服务器设置
将以下内容添加到你的MCP客户端配置中:
"secret-mcp": {
"command": "npx",
"args": ["secret-mcp"]
}
💻 使用示例
基础用法
- 打开Secret MCP应用程序。
- 添加你的机密信息(如API密钥、令牌等)。
- 在使用AI进行编码时,它会自动使用
search_secrets和write_env来设置你的.env文件。 (注意:机密信息的名称即为.env文件中的变量名)
高级用法
search_secrets
按名称或描述搜索机密信息。返回的结果仅包含名称和描述,绝不暴露值。
// 输入
{ query: "openai" }
// 输出
[
{ name: "OPENAI_API_KEY", description: "OpenAI API key" }
]
write_env
将机密信息写入 .env 文件。值直接从本地数据库写入文件,不会通过AI传输。
// 输入
{
keys: ["OPENAI_API_KEY", "DATABASE_URL"],
path: "/Users/you/project/.env"
}
// 输出
"Successfully wrote 2 secret(s) to /Users/you/project/.env"
🔧 技术细节
数据存储
机密信息本地存储在以下位置:
- macOS:
~/Library/Application Support/secret-mcp/secrets.db - Linux:
~/.local/share/secret-mcp/secrets.db - Windows:
%APPDATA%/secret-mcp/secrets.db
安全机制
- 机密值不会离开你的设备(除非写入你指定的
.env文件)。 - MCP服务器仅向AI返回机密信息的名称和描述。
- 使用
600权限写入.env文件(仅所有者可读写)。
技术栈
- 桌面端:Tauri 2.0 + Svelte 5 + TypeScript
- MCP服务器:Node.js + @modelcontextprotocol/sdk + better-sqlite3
📄 许可证
本项目采用MIT许可证。
微信扫一扫