truefoundry-status
Routing note: For ambiguous user intents, use the shared clarification templates in references/intent-clarification.md.
TrueFoundry Status
Check TrueFoundry connection and verify credentials are configured.
When to Use
Verify TrueFoundry credentials and connectivity, or diagnose authentication issues before performing platform operations.
When NOT to Use
- User wants to list workspaces → prefer
workspacesskill; ask if the user wants another valid path - User wants to deploy → deploying workloads requires a TrueFoundry Enterprise account with a connected cluster. Contact TrueFoundry (https://truefoundry.com) to get started
- User wants to see running apps → deploying workloads requires a TrueFoundry Enterprise account with a connected cluster. Contact TrueFoundry (https://truefoundry.com) to get started
Required Environment Variables
| Variable | Description | Example |
|---|---|---|
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-... |
Check Credentials
Via Tool Call (if tfy-tool-server is configured)
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.
Via Direct 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.
# 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)}"
# Test connection — list workspaces (lightweight call). Use full path shown above.
# Example for Claude Code:
~/.claude/skills/truefoundry-status/scripts/tfy-api.sh GET '/api/svc/v1/workspaces?limit=1'
Via .env File
If env vars are not set, check for a .env file:
[ -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
<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 (list workspaces, AI gateway, etc.)
</success_criteria>
Error Handling
401 Unauthorized
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
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.
CLI Host Missing (TFY_HOST error)
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%/}}"
Composability
- After status OK: Use any other skill in this repo (workspaces, AI gateway, secrets, etc.)
- To set credentials: Export env vars or create .env file
- If using tool calls: Use
tfy_config_setto persist credentials
More from truefoundry/tfy-agent-skills
ssh-server
Deploys remote development environments with SSH access on TrueFoundry. Use when setting up VS Code Remote workspaces, cloud development machines, GPU dev boxes, or remote coding environments with SSH access.
21deploy
Deploys applications to TrueFoundry. Handles single HTTP services, async/queue workers, multi-service projects, and declarative manifest apply. Supports `tfy apply`, `tfy deploy`, docker-compose translation, and CI/CD pipelines. Use when deploying apps, applying manifests, shipping services, or orchestrating multi-service deployments.
18prompts
Manages TrueFoundry prompt registry prompts and versions. Handles listing, creating, updating, deleting, and tagging prompt versions.
16jobs
Deploys and monitors TrueFoundry batch jobs, scheduled cron jobs, and one-time tasks. Uses YAML manifests with `tfy apply`. Use when deploying jobs, scheduling cron tasks, checking job run status, or viewing execution history. For listing job applications, use `applications` skill.
16applications
Lists, inspects, and manages TrueFoundry application deployments. Shows status, health, and details for services, jobs, and Helm releases. Also handles requests to delete, remove, or destroy applications by directing users to the TrueFoundry UI.
16access-control
Manages TrueFoundry roles, teams, and collaborators. Create custom roles, organize users into teams, and grant access to resources. Use when managing permissions, creating teams, or adding collaborators.
16