Expand description
Platform tools for managing Syncable platform resources
This module provides agent tools for interacting with the Syncable Platform API:
- Listing organizations and projects
- Selecting and managing project context
- Querying current context state
- Cloud provider connection management
- Service deployment management
- Service log retrieval
- Project analysis for deployment
§Tools
ListOrganizationsTool- List organizations the user belongs toListProjectsTool- List projects within an organizationSelectProjectTool- Select a project as the current contextCurrentContextTool- Get the currently selected project contextOpenProviderSettingsTool- Open cloud provider settings in browserCheckProviderConnectionTool- Check if a cloud provider is connectedListDeploymentConfigsTool- List deployment configurations for a projectTriggerDeploymentTool- Trigger a deployment using a configGetDeploymentStatusTool- Get deployment task statusListDeploymentsTool- List recent deployments for a projectGetServiceLogsTool- Get container logs for a deployed serviceAnalyzeProjectTool- Analyze project for Dockerfiles and deployment optionsAnalyzeCodebaseTool- Comprehensive codebase analysis (languages, frameworks, ports, env vars)ListDeploymentCapabilitiesTool- List available deployment targets and providersCreateDeploymentConfigTool- Create a new deployment configurationProvisionRegistryTool- Provision a new container registry
§Prerequisites
All tools require the user to be authenticated via sync-ctl auth login.
§Example Flow
- User asks: “What projects do I have access to?”
- Agent calls
list_organizationsto get available organizations - Agent calls
list_projectsfor each organization - User asks: “Select the ‘my-project’ project”
- Agent calls
select_projectwith the project and organization IDs - Agent can then use
current_contextto verify the selection
§Cloud Provider Connection Flow
- Agent calls
check_provider_connectionto see if GCP/AWS/etc is connected - If not connected, agent calls
open_provider_settingsto open browser - User completes OAuth flow in browser
- Agent calls
check_provider_connectionagain to verify
§Deployment Flow
- Agent calls
list_deployment_configsto see available deployment configs - Agent calls
trigger_deploymentwith project_id and config_id - Agent calls
get_deployment_statuswith task_id to monitor progress - Agent calls
list_deploymentsto see deployment history and public URLs - Agent calls
get_service_logsto view container logs for debugging
SECURITY NOTE: The agent NEVER handles actual credentials (OAuth tokens, API keys). It only checks connection STATUS. All credential handling happens securely in the browser through the platform’s OAuth flow.
Structs§
- Analyze
Codebase Tool - Tool to perform comprehensive codebase analysis
- Analyze
Project Tool - Tool to analyze a project directory for deployment
- Check
Provider Connection Tool - Tool to check if a cloud provider is connected to a project
- Create
Deployment Config Tool - Tool to create a new deployment configuration
- Current
Context Tool - Tool to get the currently selected project context
- Deploy
Service Tool - Tool to analyze a project and deploy it with intelligent recommendations
- GetDeployment
Status Tool - Tool to get deployment task status
- GetService
Logs Tool - Tool to get container logs for a deployed service
- List
Deployment Capabilities Tool - Tool to list available deployment capabilities for a project
- List
Deployment Configs Tool - Tool to list deployment configurations for a project
- List
Deployments Tool - Tool to list recent deployments for a project
- List
Organizations Tool - Tool to list all organizations the authenticated user belongs to
- List
Projects Tool - Tool to list all projects within an organization
- Open
Provider Settings Tool - Tool to open the cloud providers settings page in the browser
- Provision
Registry Tool - Tool to provision a new container registry
- Select
Project Tool - Tool to select a project as the current context
- Trigger
Deployment Tool - Tool to trigger a deployment using a deployment config