🚀 方形模型上下文协议服务器（Beta版本）
方形模型上下文协议服务器（Beta版本）遵循模型上下文协议标准，可让AI助手与Square的连接API进行交互，为相关开发工作提供便利。
🚀 快速开始
使用npx可快速启动方形MCP服务器，以下是不同场景下的启动命令：
基本启动
# 基本启动
npx square-mcp-server start
使用环境配置启动
# 使用环境配置
ACCESS_TOKEN=YOUR_SQUARE_ACCESS_TOKEN SANDBOX=true npx square-mcp-server start
开发模式启动
# 开发模式启动
npm run dev
配置选项
以下是可用的环境变量及其用途：
| 环境变量 | 用途 | 示例值 |
|---|---|---|
ACCESS_TOKEN |
Square API 的访问令牌 | "your_access_token" |
SANDBOX |
启用沙盒模式（用于开发和测试） | true |
PORT |
服务器运行的端口 | 3000 |
安装依赖
要安装项目所需的依赖项，请运行以下命令：
npm install
✨ 主要特性
方形MCP服务器提供以下核心功能：
- 服务信息发现：通过
get_service_info方法发现可用的服务。 - 类型信息获取：使用
get_type_info方法获取特定服务的详细信息。 - API请求执行：利用
make_api_request方法执行实际的API操作。
💻 使用示例
基础用法
1. 发现服务信息
get_service_info(service: "catalog")
2. 获取类型信息
get_type_info(service: "catalog", method: "list")
3. 执行API请求
make_api_request(service: "catalog", method: "list", request: {})
🔧 开发与调试
使用MCP检查器
为了帮助开发和调试，您可以使用MCP检查器：
# 构建项目
npm run build
# 启动检查器
npx @modelcontextprotocol/inspector node dist/index.js start
开发流程
- 克隆仓库
- 安装依赖：
npm install - 启动开发模式：
npm run watch - 运行服务器：
node dist/index.js start - 使用MCP检查器测试您的更改
🤝 贡献指南
此仓库是根据Square的OpenAPI规范自动生成的。虽然欢迎贡献，但请注意，任何更改都需要整合到生成代码的生成器中。在提交拉取请求之前，请先打开问题讨论拟议的更改。
如果您有任何问题或需要进一步的帮助，请随时联系项目维护人员。