article
README
🚀 用于与 HubSpot CRM 系统交互的 Model Context Protocol (MCP) 服务器
这是一个专门用于与 HubSpot CRM 系统交互的 MCP 服务器。它提供了丰富的功能,可创建和更新联系人及公司信息,还能获取活动历史记录与最近的互动数据,为用户管理 CRM 系统提供了便利。
🚀 快速开始
本 MCP 服务器可帮助你高效地与 HubSpot CRM 系统进行交互,实现联系人与公司信息的管理、活动记录查询等功能。
✨ 主要特性
- TypeScript 开发:运用现代 TypeScript 语言编写,保证代码清晰且具备类型安全。
- 异步操作:借助承诺达成非阻塞 IO 操作,有效提升性能。
- 模块化设计:采用模块化结构,便于对系统进行扩展和维护。
- 全面的文档支持:提供详尽的 API 文档与使用说明。
📦 安装指南
- 克隆项目仓库:
git clone <repository-url> cd hubspot-mcp-server - 安装依赖项:
npm install
💻 使用示例
基础用法
联系人管理
- 创建联系人:
npm run create-contact -- [姓名] [邮箱] - 更新联系人信息:
npm run update-contact -- [联系人ID] [属性]
公司管理
- 创建公司:
npm run create-company -- [公司名称] - 更新公司信息:
npm run update-company -- [公司ID] [属性]
活动记录查询
- 获取特定公司的活动历史:
npm run get-company-activity -- [公司ID] - 查看最近互动:
npm run get-recent-engagements -- [--天数=7] [--限制=50]
高级用法
若你需要对系统进行扩展或自定义日志输出,可参考以下内容:
- 新增功能:通过扩展
HubSpotClient类并在setupToolHandlers方法中注册新工具,能够轻松添加更多 HubSpot API 功能。 - 自定义日志:根据实际需求修改日志记录级别,实现更详细的调试信息输出。
📚 详细文档
配置说明
- 环境变量:需要设置
HUBSPOT_API_KEY环境变量,以确保服务器能够连接到 HubSpot API。
常见问题
- 如何获取 API 密钥?
- 登录 HubSpot 账户,在设置中找到开发者工具,生成新的 API 密钥。
- 服务器无法启动怎么办?
- 检查环境变量是否正确设置,并确保网络连接正常。
📄 许可证
本项目遵循 MIT 许可证,具体内容请参见 LICENSE 文件。
微信扫一扫