mcpField
P
pier-cloud

pier-cloud

github.com/fabricioctelles云与 DevOps12383 次安装2 天前更新
代码仓库

关于 pier-cloud

pier-cloud 提供脚本和可复用的 Python 客户端，用于访问 Pier Cloud API，支持通过认证查询 contexts、workspaces、views 和 workspace groups。

主要功能

  1. 01使用凭据进行 JWT 认证
  2. 02列出 contexts 和分页 workspaces
  3. 03获取 workspace 与 view 详情
  4. 04按筛选条件查询 view 数据
  5. 05访问 workspace groups

适用场景

  1. 01自动分页列出所有 workspaces
  2. 02获取 workspace view 的筛选数据
  3. 03在较长会话中续期 JWT

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/fabricioctelles/skills --skill pier-cloud

安装后在 Claude Code 中输入/pier-cloud确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

.env.example
references/
REFERENCE.md
TROUBLESHOOTING.md
scripts/
pier_cloud_client.py
pier-cloud-auth.py
pier-cloud-get-all-workspaces.py
pier-cloud-get-view-data.py
pier-cloud-get-view.py
pier-cloud-get-workspace-group.py
pier-cloud-get-workspace.py
pier-cloud-list-contexts.py
pier-cloud-list-views.py
pier-cloud-list-workspace-groups.py
pier-cloud-list-workspaces.py
README.md

详细介绍

Pier Cloud API

前提条件

凭据

在技能目录中找到 .env 文件，其中包含以下变量：

PIERCLOUD_CLIENT_ID=your_client_id
PIERCLOUD_CLIENT_SECRET=your_client_secret
PIERCLOUD_TENANCY_ID=your_tenancy_id

如果 .env 文件不存在，请告知用户，必须先从 Pier Cloud 平台获取凭据才能继续。没有 .env 文件时，请勿继续。

注意：PIERCLOUD_TENANCY_ID 等同于旧版 PIERCLOUD_BUSINESS_ID。脚本会将两者都作为备用变量接受。

Python 依赖项
pip install requests python-dotenv

基本配置

API 使用 JWT 身份验证。所需流程：

  1. 使用 client_id 和 client_secret 通过 POST /auth 进行身份验证，以获取 JWT 令牌
  2. 在所有请求中包含令牌：Authorization: Bearer {token}
  3. 令牌过期后续期（默认有效期：1 小时）

基础 URL：https://api.piercloud.io

工作区组位于 /lighthouse/tenancies/{tenancy_id}/workspaces-groups（注意 workspaces 是复数形式）。

运行以下命令验证连接：

python scripts/pier-cloud-auth.py

可用脚本

scripts/ 中提供了可直接使用的脚本。详细说明请参阅 scripts/README.md。

脚本描述
pier-cloud-auth.py进行身份验证并获取 JWT 令牌
pier-cloud-list-contexts.py列出可用上下文
pier-cloud-list-workspaces.py分页列出工作区
pier-cloud-get-workspace.py获取特定工作区的详细信息
pier-cloud-get-all-workspaces.py获取所有工作区（自动分页）
pier-cloud-list-views.py列出工作区的视图
pier-cloud-get-view.py获取特定视图的信息
pier-cloud-get-view-data.py获取带筛选条件的视图数据
pier-cloud-list-workspace-groups.py列出工作区组（/workspaces-groups）
pier-cloud-get-workspace-group.py按 id 获取工作区组
pier_cloud_client.py功能健全的客户端，包含 CLI 和可复用库

工作流

请按照 references/REFERENCE.md 中附有请求和响应示例的详细工作流操作：

  • 工作流 1 — 身份验证和令牌获取
  • 工作流 2 — 列出上下文
  • 工作流 3 — 列出工作区
  • 工作流 4 — 获取工作区详细信息
  • 工作流 5 — 获取所有工作区（自动分页）
  • 工作流 6 — 支持重试和令牌续期的健全客户端
  • 工作流 9 — 列出工作区视图
  • 工作流 10 — 获取视图信息
  • 工作流 11 — 获取带筛选条件的视图数据
  • 工作流 12 — 列出工作区组（/workspaces-groups）
  • 工作流 13 — 获取工作区组详细信息

有关端点参考、参数、响应结构和 cURL 示例，请参阅 references/REFERENCE.md。

有关错误诊断（401、403、404、超时、速率限制），请参阅 references/TROUBLESHOOTING.md。

其他资源

质量检查清单

  • .env 文件存在，并包含 PIERCLOUD_CLIENT_ID、PIERCLOUD_CLIENT_SECRET 和 PIERCLOUD_TENANCY_ID
  • 已安装 Python 依赖项（requests、python-dotenv）
  • 身份验证成功（已获取 JWT 令牌，且没有错误）
  • 使用了正确的端点（/lighthouse/tenancies/{tenancy_id}/...；组使用 workspaces-groups）
  • 长时间会话中，在令牌过期前续期
  • 通过列表确认工作区/视图 ID 后再直接使用
  • 按照 references/TROUBLESHOOTING.md 处理错误

评论

支持 Markdown