AGENT SKILL

pm-square

Square connector knowledge and safe action guide.

License 许可
AGPL-3.0
所属仓库
polymetrics-ai/cli
最近更新
2026-09-21
Stars
★ 7
Forks
0

01 前言 Front Matter

name
pm-square
description
Square connector knowledge and safe action guide.

02 资源文件 1

03 SKILL.md 正文

pm-square

Purpose

Reads Square payments, refunds, customers, and locations through the Square Connect v2 REST API.

Icon

Capabilities

  • check=true catalog=true read=true write=false query=false
  • Integration type: api

Authentication

  • Use pm credentials add with --from-env or --value-stdin for secret fields.

Configuration

  • base_url
  • max_pages
  • mode
  • page_size
  • start_date
  • api_key (secret) (required)

ETL Streams

  • payments:
    • primary key: id
    • cursor: updated_at
    • fields: amount_money(object), created_at(string), id(string), location_id(string), order_id(string), processing_fee(array), receipt_number(string), source_type(string), status(string), total_money(object), updated_at(string)
  • refunds:
    • primary key: id
    • cursor: updated_at
    • fields: amount_money(object), created_at(string), id(string), location_id(string), order_id(string), payment_id(string), processing_fee(array), reason(string), status(string), updated_at(string)
  • customers:
    • primary key: id
    • cursor: updated_at
    • fields: company_name(string), created_at(string), creation_source(string), email_address(string), family_name(string), given_name(string), id(string), phone_number(string), reference_id(string), updated_at(string)
  • locations:
    • primary key: id
    • fields: country(string), created_at(string), currency(string), id(string), merchant_id(string), name(string), status(string), timezone(string), type(string)

Sync Modes

  • ETL sync modes: full_refresh_append, full_refresh_overwrite, full_refresh_overwrite_deduped, incremental_append, incremental_append_deduped

Security

  • read risk: external Square API read of payments, refunds, customer, and location data
  • approval: none; read-only
  • Never pass secret values in chat, shell arguments, logs, docs, or JSON output.

Commands

Inspect as a manual

pm connectors inspect square

Inspect as structured JSON

pm connectors inspect square --json

Agent Rules

  • Run pm connectors inspect square before creating credentials or plans.
  • Use --json only when the caller needs structured output; use the manual for human-readable guidance.
  • Never ask the user to paste secret values into chat.

04 同仓库更多 Skills