article
README
🚀 SignNow API Helper MCP
SignNow API Helper MCP是一个专为SignNow API集成提供帮助的自定义模型上下文协议(MCP)服务器,它能理解SignNow API生态系统,为开发者提供上下文帮助。
🚀 快速开始
SignNow API Helper MCP服务器是一个定制的模型上下文协议服务器,专门用于协助SignNow API集成。它就像一个智能助手,了解SignNow API生态系统,为开发者提供上下文帮助。
✨ 主要特性
核心功能
- API文档访问:检索并展示SignNow API文档、端点和参数。
- 代码示例:为常见的SignNow API操作生成并提供示例代码。
- 认证帮助:协助处理SignNow API认证方法和令牌管理。
- 集成指导:提供实施SignNow电子签名工作流程的最佳实践。
- 错误解决:帮助排查常见的SignNow API问题和错误代码。
使用场景
- 文档签署工作流程:帮助实现涉及多个签署人的复杂签署流程。
- API集成:生成用于上传文档、创建签名请求和跟踪状态的代码。
- 开发支持:在SignNow API开发过程中提供实时帮助。
- 最佳实践:确保正确实施SignNow的安全和合规要求。
📦 安装指南
若要在本地进行开发安装,请使用以下命令:
pip install -e .
💻 使用示例
启动服务器
可以使用Python或uvx来运行服务器:
- 方法1:使用Python模块
python -m sn_api_helper_mcp serve
- 方法2:使用已安装的CLI入口点
sn-api-helper-mcp serve
- 方法3:使用UVX
uvx sn-api-helper-mcp
🔌 集成与设置
可以将此服务器与任何MCP客户端一起使用。以下是最流行的IDE和应用程序的配置说明。
1. Claude Desktop
若要在Claude应用程序中直接使用SignNow工具,请按以下步骤操作:
- 打开配置文件:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
- macOS:
- 在
mcpServers对象中添加以下内容:
{
"mcpServers": {
"signnow-api-helper": {
"command": "uvx",
"args": [
"sn-api-helper-mcp"
]
}
}
}
- 重启Claude Desktop。
2. Cursor AI
Cursor原生支持MCP。
- 打开Cursor设置(
Cmd/Ctrl + ,)。 - 转到功能 > MCP服务器。
- 点击**+ 添加新的MCP服务器**。
- 在
mcpServers对象中添加以下内容:
{
"mcpServers": {
"signnow-api-helper": {
"command": "uvx",
"args": ["sn-api-helper-mcp"]
}
}
}
3. Visual Studio Code(通过Cline)
VS Code使用Cline扩展(或类似的MCP客户端)与MCP服务器进行交互。
- 从VS Code应用商店安装Cline扩展。
- 打开Cline设置(点击Cline聊天窗口内的齿轮图标) -> MCP服务器。
- 添加配置JSON:
{
"signnow-api-helper": {
"command": "uvx",
"args": [
"sn-api-helper-mcp"
]
}
}
✨ 主要特性
- 传输方式:仅支持标准输入输出(stdio)
- 可用工具:
get_signnow_api_info- 获取API参考文档。
📄 许可证
本项目遵循 此处 所示的许可证。
微信扫一扫