NicePay MCP服务器
用于Nice Pay开发者指南的Model Context Protocol(MCP)服务器。
此MCP服务器使您可以在Cursor IDE或其他MCP兼容工具中轻松搜索和查看Nice Pay API文档。
参考:此项目 Nice Famants官方手册存储库基于的标记文档工作。
功能
1.搜索文档(search_nicepay_docs)
使用关键字搜索Nice Pay开发者指南文档。
使用示例:
- “付款窗口”
- “取消”
- “网络钩子”
- API
2.查看API端点(get_api_endpoint)
查询特定API端点的详细信息。
查询内容:
- HTTP方法(GET、POST등)
- 端点URL
- 请求/响应参数
- 示例代码
使用示例:
- “批准付款”
- “查询交易”
- “取消”
3.查看代码示例(get_code_sample)
提供主题和语言的代码示例。
使用示例:
- 主题:“呼叫支付窗口”,语言:“javascript”
- 主题:“基本认证”,语言:“curl”
- 主题:“批准付款”
4.查询JS SDK方法(get_sdk_method)
提供JS SDK方法的使用和参数信息。
使用示例:
- “requestPay”
- “cancelPay”
- “AUTHNICE.requestPay”
安装
要求
- Node.js 18或更高版本
- npm或yarn
安装方法
- 转到项目目录:
cd mcp-server- 依赖性安装:
npm install- 版本:
npm run build使用方法
Cursor IDE设置
- Cursor设置文件(
.cursorrules或MCP设置)。
- 添加MCP服务器:
{
"mcpServers": {
"nicepay": {
"command": "node",
"args": ["/path/to/mcp-server/dist/index.js"]
}
}
}注意: 以上路径必须更改为实际项目路径。
运行开发模式
开发中 tsx可以使用运行:
npm run dev生产构建
npm run build
npm start项目结构
mcp-server/
├── src/
│ ├── index.ts # MCP 서버 진입점
│ └── utils/
│ ├── docIndexer.ts # 문서 인덱싱 시스템
│ ├── markdownParser.ts # 마크다운 파서
│ └── logger.ts # 로깅 유틸리티
├── dist/ # 빌드 결과물
├── package.json
├── tsconfig.json
└── README.md文档路径
服务器自动为以下目录中的标记文件编制索引:
api/-API规范文档common/-通用指南文档management/-操作文档migration/-迁移文档
这些文件 Nice Famants官方手册存储库在中提供。
文档结构: 服务器位于项目根目录的父目录(../../)找到上述目录并编制索引。 如果克隆了正式存储库,请将此MCP服务器置于该存储库的子目录中。 DOCS_BASE_PATH 可以将文档路径指定为环境变量。
脚本
npm run build-编译TypeScriptnpm start-运行生成的文件npm run dev-运行开发模式(使用tsx)npm run watch-通过检测文件更改自动构建
记录
服务器 stderr通过输出日志。日志级别:
ERROR-出现错误WARN-警告事项INFO-信息性消息DEBUG-调试信息
故障排除
文档索引失败
如果服务器启动时文档索引失败,请检查日志。索引失败时,服务器将继续运行,但搜索功能可能会受到限制。
MCP连接失败
- 验证Node.js版本是否为18或更高版本
- 验证构建是否已完成(
dist/index.js文件是否存在) - 验证路径是否正确
没有搜索结果时
- 更改关键字重试
- 不区分大小写,可以自由输入
许可证
麻省理工学院
贡献
如果有问题或改善事项,请告诉我!
