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

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

빠른 시작

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

지엑스피1

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

Related MCP server: Linear MCP Server

원격 MCP 서버

Square는 이제 다음 위치에서 호스팅되는 원격 MCP 서버를 제공합니다.

https://mcp.squareup.com/sse

원격 MCP는 OAuth 인증을 사용하므로 액세스 토큰을 수동으로 만들거나 관리하지 않고도 Square 계정으로 직접 로그인할 수 있으므로 권장됩니다.

구성 옵션

AI 어시스턴트와의 통합

구스 통합

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

원격 MCP

Goose에 Square 원격 MCP를 설치하려면 Goose가 설치된 컴퓨터에서 이 URL을 클릭하세요.

goose://extension?cmd=npx&arg=mcp-remote&arg=https%3A%2F%2Fmcp.squareup.com%2Fsse&id=square_mcp_production_remote&name=Square%20MCP%20Remote&description=Square%20Production%20MCP%20Remote

또는 URL을 복사하여 브라우저의 주소창에 붙여넣으세요.

# 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 파일에 다음 구성을 추가하세요.

원격 MCP

{
  "mcpServers": {
    "mcp_square_api": {
      "command": "npx",
      "args": ["mcp-remote", "https://mcp.squareup.com/sse"]
    }
  }
}

이 접근 방식을 사용하면 액세스 토큰을 관리할 필요 없이 Square 계정 자격 증명으로 직접 인증할 수 있습니다.

지역 MCP

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

도구 참조

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

서비스 카탈로그

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

사용 패턴

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

1. 발견 : get_service_info 사용하여 사용 가능한 방법을 탐색합니다.

   get_service_info(service: "catalog")

2. 이해 : get_type_info 사용하여 매개변수 요구 사항을 알아보세요

   get_type_info(service: "catalog", method: "list")

3. 실행 : 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

개발 워크플로

1. 저장소를 복제합니다

2. 종속성 설치: npm install

3. 개발 모드 시작: npm run watch

4. 서버를 실행합니다: node dist/index.js start

5. MCP 검사기를 사용하여 변경 사항을 테스트하세요

기여하다

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