README
🚀 为我的API服务
一个基于MCP(模型上下文协议)的个人服务器,可通过macOS钥匙链安全存储和访问项目之间的API密钥,保障密钥安全与便捷使用。
⚠️ 重要提示
ServeMyAPI 是专为 macOS 设计的工具,目前仅支持 macOS 系统。钥匙扣内容受到系统保护,需要用户身份验证才能访问。
🚀 快速开始
ServeMyAPI 能让你以安全方式存储和管理 API 密钥。借助 MCP 协议集成,语言模型(如 Claude 或其他 AI 工具)可方便获取所需密钥,同时避免敏感信息明文存储与泄露。
📦 安装指南
# 克隆仓库
git clone [Your Repository URL]
cd servemyapi
# 安装依赖项
npm install
# 开发模式启动(带有热重载)
npm run dev
💻 使用示例
基础用法
初始化项目
在项目根目录下创建并编辑 package.json 文件,添加以下内容:
{
"name": "your-project-name",
"version": "1.0.0",
"scripts": {
"serve": "node dist/index.js"
},
"dependencies": {
"servemyapi": "file:."
}
}
配置钥匙链访问
在终端中运行以下命令,确保你拥有对系统钥匙链的读写权限:
security list-keychains -d
根据提示输入你的管理员密码。
高级用法
示例操作
存储密钥
node dist/index.js store --name "OpenAI API Key" --key "your-api-key-here"
检索密钥
node dist/index.js get --name "OpenAI API Key"
删除密钥
node dist/index.js delete --name "OpenAI API Key"
列出所有密钥
node dist/index.js list
✨ 主要特性
- 存储密钥:通过
store-api-key工具将敏感信息安全地保存到系统钥匙链。 - 检索密钥:使用
get-api-key工具从钥匙链中获取特定密钥,用于 API 请求或其他需要身份验证的操作。 - 删除密钥:通过
delete-api-key工具移除不再需要的密钥条目。 - 列出所有密钥:使用
list-api-keys工具查看存储的所有密钥及其标识符。
🔧 技术细节
- 访问控制:钥匙链内容受到系统级保护,只有当前登录用户可以访问。
- 加密存储:所有密钥均以加密形式存储,不会以明文形式保存在文件系统中。
- 审计日志:默认情况下不记录任何操作日志,建议根据需求启用审计功能。
📚 详细文档
开发指南
# 启动开发服务器
npm run dev
# 使用 CLI 工具
npm run cli list
# 代码格式检查
npm run lint
# 构建生产版本
npm run build
🤝 贡献与支持
欢迎提出问题、建议或功能请求。若发现任何安全漏洞,请立即报告。
📄 许可证
MIT
Scan to join WeChat group