Back to Details

truefoundry-status

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
Routing note: For ambiguous user intents, use the shared clarification templates in references/intent-clarification.md.
<objective>
路由说明：针对不明确的用户意图，请使用 references/intent-clarification.md 中的通用澄清模板。
<objective>

TrueFoundry Status

TrueFoundry 状态检查

Check TrueFoundry connection and verify credentials are configured.
检查TrueFoundry连接并验证凭证是否已配置。

When to Use

适用场景

Verify TrueFoundry credentials and connectivity, or diagnose authentication issues before performing platform operations.
在执行平台操作前验证TrueFoundry凭证和连通性，或排查身份认证问题。

When NOT to Use

不适用场景

  • User wants to list workspaces → prefer 
    workspaces
    skill; ask if the user wants another valid path
  • User wants to deploy → prefer 
    deploy
    skill; ask if the user wants another valid path
  • User wants to see running apps → prefer 
    applications
    skill; ask if the user wants another valid path
</objective> <context>
  • 用户想要列出工作区 → 优先使用
    workspaces
    技能；询问用户是否需要其他有效路径
  • 用户想要部署 → 优先使用
    deploy
    技能；询问用户是否需要其他有效路径
  • 用户想要查看运行中的应用 → 优先使用
    applications
    技能；询问用户是否需要其他有效路径
</objective> <context>

Required Environment Variables

必填环境变量

VariableDescriptionExample
TFY_BASE_URL
TrueFoundry platform URL
https://your-org.truefoundry.cloud
TFY_HOST
CLI host alias (recommended when 
TFY_API_KEY
is set for CLI commands)
https://your-org.truefoundry.cloud
TFY_API_KEY
API key (raw, no Bearer prefix)
tfy-...
</context> <instructions>
变量描述示例
TFY_BASE_URL
TrueFoundry平台URL
https://your-org.truefoundry.cloud
TFY_HOST
CLI主机别名（当为CLI命令设置了
TFY_API_KEY
时推荐使用）
https://your-org.truefoundry.cloud
TFY_API_KEY
API密钥（原始值，不需要Bearer前缀）
tfy-...
</context> <instructions>

Check Credentials

检查凭证

Via Tool Call (if tfy-tool-server is configured)

通过工具调用（如果已配置tfy-tool-server）

If the TrueFoundry tool server is available, use this tool call:
tfy_config_status
This returns connection status, configured base URL, and whether an API key is set.
如果TrueFoundry工具服务器可用，使用此工具调用：
tfy_config_status
该调用会返回连接状态、已配置的基础URL，以及是否设置了API密钥。

Via Direct API

通过直接API调用

Check environment variables and test the connection. Set 
TFY_API_SH
to the full path of this skill's 
scripts/tfy-api.sh
. See 
references/tfy-api-setup.md
for paths per agent.
bash
undefined
检查环境变量并测试连接。将
TFY_API_SH
设置为当前技能下
scripts/tfy-api.sh
的完整路径。各Agent的路径请查看
references/tfy-api-setup.md
。
bash
undefined

Check env vars are set

Check env vars are set

echo "TFY_BASE_URL: ${TFY_BASE_URL:-(not set)}" echo "TFY_HOST: ${TFY_HOST:-(not set)}" echo "TFY_API_KEY: ${TFY_API_KEY:+(set)}${TFY_API_KEY:-(not set)}"
echo "TFY_BASE_URL: ${TFY_BASE_URL:-(not set)}" echo "TFY_HOST: ${TFY_HOST:-(not set)}" echo "TFY_API_KEY: ${TFY_API_KEY:+(set)}${TFY_API_KEY:-(not set)}"

Test connection — list workspaces (lightweight call). Use full path shown above.

Test connection — list workspaces (lightweight call). Use full path shown above.

Example for Claude Code:

Example for Claude Code:

~/.claude/skills/truefoundry-status/scripts/tfy-api.sh GET '/api/svc/v1/workspaces?limit=1'
undefined
~/.claude/skills/truefoundry-status/scripts/tfy-api.sh GET '/api/svc/v1/workspaces?limit=1'
undefined

Via .env File

通过.env文件检查

If env vars are not set, check for a 
.env
file:
bash
[ -f .env ] && echo ".env found" || echo "No .env file"
如果环境变量未设置，检查是否存在
.env
文件：
bash
[ -f .env ] && echo ".env found" || echo "No .env file"

Presenting Status

状态展示

TrueFoundry Status:
- Base URL: https://your-org.truefoundry.cloud ✓
- API Key: configured ✓
- Connection: OK (listed 1 workspace)
Or if something is wrong:
TrueFoundry Status:
- Base URL: (not set) ✗
- API Key: (not set) ✗

Set TFY_BASE_URL and TFY_API_KEY in your environment or .env file.
If you do not have a TrueFoundry account yet, run: uv run tfy register
That flow may open a browser for CAPTCHA or human verification before email verification completes.
Get an API key: https://docs.truefoundry.com/docs/generating-truefoundry-api-keys
</instructions>
<success_criteria>
  • The user can confirm whether TFY_BASE_URL and TFY_API_KEY are correctly set
  • The agent has tested the API connection with a lightweight call and reported the result
  • The user can see a clear status summary showing which components are configured and which are missing
  • The agent has provided actionable next steps if any credential or connectivity issue was found
  • The user knows which skill to use next based on their goal (
    deploy
    , list workspaces, etc.)
</success_criteria>
<troubleshooting>
TrueFoundry Status:
- Base URL: https://your-org.truefoundry.cloud ✓
- API Key: configured ✓
- Connection: OK (listed 1 workspace)
如果出现异常：
TrueFoundry Status:
- Base URL: (not set) ✗
- API Key: (not set) ✗

Set TFY_BASE_URL and TFY_API_KEY in your environment or .env file.
If you do not have a TrueFoundry account yet, run: uv run tfy register
That flow may open a browser for CAPTCHA or human verification before email verification completes.
Get an API key: https://docs.truefoundry.com/docs/generating-truefoundry-api-keys
</instructions>
<success_criteria>
  • 用户可确认TFY_BASE_URL和TFY_API_KEY是否已正确设置
  • Agent已通过轻量调用测试API连接并反馈结果
  • 用户可看到清晰的状态汇总，显示哪些组件已配置、哪些缺失
  • 如果发现任何凭证或连通性问题，Agent已提供可执行的后续步骤
  • 用户可根据自身目标知晓下一步使用哪个技能（
    deploy
    、列出工作区等）
</success_criteria>
<troubleshooting>

Error Handling

错误处理

401 Unauthorized

401 未授权

API key is invalid or expired. Generate a new one:
https://docs.truefoundry.com/docs/generating-truefoundry-api-keys
API key is invalid or expired. Generate a new one:
https://docs.truefoundry.com/docs/generating-truefoundry-api-keys

Connection Refused / Timeout

连接被拒绝/超时

Cannot reach TFY_BASE_URL. Check:
- URL is correct (include https://)
- Network/VPN is connected
Cannot reach TFY_BASE_URL. Check:
- URL is correct (include https://)
- Network/VPN is connected

Missing Variables

变量缺失

TFY_BASE_URL and TFY_API_KEY are required.
Set them via environment variables or add to .env in project root.
If the user is new to TrueFoundry, have them run `uv run tfy register` first,
complete any browser-based CAPTCHA or human verification it requests, verify their email,
open the returned tenant URL, and create a PAT there.
TFY_BASE_URL and TFY_API_KEY are required.
Set them via environment variables or add to .env in project root.
If the user is new to TrueFoundry, have them run `uv run tfy register` first,
complete any browser-based CAPTCHA or human verification it requests, verify their email,
open the returned tenant URL, and create a PAT there.

CLI Host Missing (
TFY_HOST
error)

CLI主机缺失（
TFY_HOST
错误）

If tfy CLI says: "TFY_HOST env must be set since TFY_API_KEY env is set"
run: export TFY_HOST="${TFY_HOST:-${TFY_BASE_URL%/}}"
</troubleshooting> <references>
If tfy CLI says: "TFY_HOST env must be set since TFY_API_KEY env is set"
run: export TFY_HOST="${TFY_HOST:-${TFY_BASE_URL%/}}"
</troubleshooting> <references>

Composability

可组合性

  • After status OK: Use any other skill (workspaces, applications, deploy, etc.)
  • To set credentials: Export env vars or create .env file
  • If using tool calls: Use 
    tfy_config_set
    to persist credentials
</references>
  • 状态正常后：可使用任意其他技能（workspaces、applications、deploy等）
  • 设置凭证：导出环境变量或创建.env文件
  • 如果使用工具调用：使用
    tfy_config_set
    持久化存储凭证
</references>