article
README
🚀 Salesforce MCP 服务器
这是一个用于测试和开发的本地模拟服务器,它能够 mocking Salesforce CLI 命令,为开发和测试工作提供便利。
🚀 快速开始
本服务器是用于测试和开发目的的本地模拟服务器,可 mocking Salesforce CLI 命令。你可以按照以下步骤快速搭建并使用它。
✨ 主要特性
- 🔄 模拟 Salesforce CLI 命令,方便进行开发和测试。
- 🏠 提供本地开发环境,让你可以在本地进行相关操作。
- ⚙️ 可配置端点,满足不同的使用需求。
- 📝 具备日志记录和错误处理功能,便于问题排查。
- 🔐 拥有安全功能(CORS、Helmet),保障服务器安全。
- 🛠️ 环境基于配置,可灵活调整。
📦 安装指南
先决条件
- Node.js (v14 或更高版本)
- npm (v6 或更高版本)
安装步骤
- 克隆仓库:
git clone <repository-url>
cd mcp-server
- 安装依赖项:
npm install
- 配置环境变量:
cp .env.example .env
# 编辑 .env 文件进行配置
💻 使用示例
基础用法
开发模式
npm run dev
生产模式
npm run build
npm start
测试
npm test
📚 详细文档
配置
服务器可通过环境变量在 .env 文件中进行配置:
| 属性 | 详情 |
|------|------|
| PORT | 服务器端口(默认:6101) |
| HOST | 服务器主机(默认:localhost) |
| NODE_ENV | 环境(开发/生产) |
| LOG_LEVEL | 日志级别(info/debug/error) |
| CORS_ORIGIN | CORS 源 |
| API_KEY | API 密钥进行身份验证 |
| SF_LOGIN_URL | Salesforce 登录 URL |
| SF_API_VERSION | Salesforce API 版本 |
API 端点
服务器模拟以下 Salesforce CLI 命令:
- 大纲测试执行
- 组织管理
- 包件管理
- 源代码管理
安全性
- 已启用并可配置 CORS
- 使用 Helmet 进行安全头设置
- API 密钥身份验证
- 请求验证
- 错误处理
日志记录
日志输出到:
- 控制台(开发环境)
error.log(错误日志)combined.log(所有日志)
贡献指南
- 叉仓库
- 创建功能分支
- 提交你的更改
- 推送到分支
- 创建 Pull Request
📄 许可证
本项目采用 MIT 许可证。
微信扫一扫