Square 모델 컨텍스트 프로토콜 서버

Square 모델 컨텍스트 프로토콜 서버(베타)

이 프로젝트는 모델 컨텍스트 프로토콜 표준을 따르므로 AI 어시스턴트가 Square의 Connect API와 상호 작용할 수 있습니다.

빠른 시작

npx를 사용하여 Square MCP 서버를 시작하고 실행하세요.

지엑스피1

YOUR_SQUARE_ACCESS_TOKEN 실제 Square 액세스 토큰으로 바꾸세요. Square 액세스 토큰 가이드에 따라 액세스 토큰을 얻을 수 있습니다. 명령을 실행하기 전에 환경 변수를 설정할 수도 있습니다.

구성 옵션

환경 변수	목적	예
`ACCESS_TOKEN`	Square API 액세스 토큰	`ACCESS_TOKEN=sq0atp-...`
`SANDBOX`	Square 샌드박스 환경 사용	`SANDBOX=true`
`PRODUCTION`	Square 프로덕션 환경 사용	`PRODUCTION=true`
`DISALLOW_WRITES`	읽기 전용 작업으로 제한	`DISALLOW_WRITES=true`
`SQUARE_VERSION`	Square API 버전 지정	`SQUARE_VERSION=2025-04-16`

AI 어시스턴트와의 통합

구스 통합

Goose 로 Square MCP 서버를 구성하려면:

# Automatic installation
npx square-mcp-server install

# Get URL for manual installation
npx square-mcp-server get-goose-url

install 명령은 자동으로 Goose 구성을 업데이트합니다.

Claude 데스크톱 통합

Claude Desktop 통합에 대한 자세한 내용은 모델 컨텍스트 프로토콜 빠른 시작 가이드를 참조하세요. claude_desktop_config.json 파일에 다음 구성을 추가하세요.

{
  "mcpServers": {
    "mcp_square_api": {
      "command": "npx",
      "args": [
        "square-mcp-server",
        "start"
      ],
      "env": {
        "ACCESS_TOKEN": "YOUR_SQUARE_ACCESS_TOKEN",
        "SANDBOX": "true"
      }
    }
  }
}

도구 참조

Square MCP 서버는 Square API와 상호 작용하기 위한 간소화된 도구 세트를 제공합니다.

도구	설명	주요 용도
`get_service_info`	서비스에 사용 가능한 방법을 알아보세요	탐험과 발견
`get_type_info`	자세한 매개변수 요구 사항을 확인하세요	요청 준비
`make_api_request`	Square에 API 호출을 실행합니다.	작업 수행

서비스 카탈로그

Square MCP 서버는 Square의 전체 API 생태계 에 대한 액세스를 제공합니다. 각 서비스에 대한 자세한 내용은 Square API 문서를 참조하세요.

서비스	설명
`applepay`	Apple Pay 통합
`bankaccounts`	은행 계좌 관리
`bookingcustomattributes`	예약을 위한 사용자 정의 속성
`bookings`	약속 예약 관리
`cards`	결제 카드 관리
`cashdrawers`	금전함 관리
`catalog`	카탈로그 관리(품목, 카테고리 등)
`checkout`	체크아웃 및 결제 처리
`customercustomattributes`	고객을 위한 사용자 정의 속성
`customergroups`	고객 그룹화
`customersegments`	고객 세분화
`customers`	고객 관리
`devices`	스퀘어 기기 관리
`disputes`	결제 분쟁 처리
`events`	이벤트 추적
`giftcardactivities`	기프트 카드 활동 추적
`giftcards`	기프트 카드 관리
`inventory`	재고 추적
`invoices`	송장 관리
`labor`	인력 관리
`locationcustomattributes`	위치에 대한 사용자 정의 속성
`locations`	위치 관리
`loyalty`	로열티 프로그램 관리
`merchantcustomattributes`	판매자를 위한 사용자 정의 속성
`merchants`	가맹점 계정 관리
`oauth`	입증
`ordercustomattributes`	주문에 대한 사용자 정의 속성
`orders`	주문 관리
`payments`	결제 처리
`payouts`	지급 관리
`refunds`	환불 관리
`sites`	웹사이트 통합
`snippets`	Square Online 코드 통합
`subscriptions`	구독 관리
`team`	직원 관리
`terminal`	스퀘어 터미널 관리
`vendors`	공급업체 관리
`webhooksubscriptions`	이벤트 알림

사용 패턴

MCP를 통해 Square API와 최적의 상호 작용을 위해:

발견 : get_service_info 사용하여 사용 가능한 방법을 탐색합니다.
get_service_info(service: "catalog")
이해 : get_type_info 사용하여 매개변수 요구 사항을 알아보세요
get_type_info(service: "catalog", method: "list")
실행 : make_api_request 사용하여 작업을 수행합니다.
make_api_request(service: "catalog", method: "list", request: {})

개발 및 디버깅

MCP Inspector 사용

MCP Inspector는 테스트를 위한 시각적 인터페이스를 제공합니다.

# Build the project
npm run build

# Start the inspector with the Square MCP Server
npx @modelcontextprotocol/inspector node dist/index.js start

개발 워크플로

저장소를 복제합니다
종속성 설치: npm install
개발 모드 시작: npm run watch
서버를 실행합니다: node dist/index.js start
MCP 검사기를 사용하여 변경 사항을 테스트하세요

기여하다

이 저장소는 Square의 OpenAPI 사양을 기반으로 자동 생성됩니다. 기여는 환영하지만, 변경 사항은 이 코드를 생성하는 생성기에 반영되어야 합니다. 풀 리퀘스트를 제출하기 전에 이슈를 열어 제안된 변경 사항에 대해 논의해 주세요.

Square Model Context Protocol Server

Integrations