Module platform

Module platform 

Source
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 to
  • ListProjectsTool - List projects within an organization
  • SelectProjectTool - Select a project as the current context
  • CurrentContextTool - Get the currently selected project context
  • OpenProviderSettingsTool - Open cloud provider settings in browser
  • CheckProviderConnectionTool - Check if a cloud provider is connected
  • ListDeploymentConfigsTool - List deployment configurations for a project
  • TriggerDeploymentTool - Trigger a deployment using a config
  • GetDeploymentStatusTool - Get deployment task status
  • ListDeploymentsTool - List recent deployments for a project
  • GetServiceLogsTool - Get container logs for a deployed service
  • AnalyzeProjectTool - Analyze project for Dockerfiles and deployment options
  • AnalyzeCodebaseTool - Comprehensive codebase analysis (languages, frameworks, ports, env vars)
  • ListDeploymentCapabilitiesTool - List available deployment targets and providers
  • CreateDeploymentConfigTool - Create a new deployment configuration
  • ProvisionRegistryTool - Provision a new container registry

§Prerequisites

All tools require the user to be authenticated via sync-ctl auth login.

§Example Flow

  1. User asks: “What projects do I have access to?”
  2. Agent calls list_organizations to get available organizations
  3. Agent calls list_projects for each organization
  4. User asks: “Select the ‘my-project’ project”
  5. Agent calls select_project with the project and organization IDs
  6. Agent can then use current_context to verify the selection

§Cloud Provider Connection Flow

  1. Agent calls check_provider_connection to see if GCP/AWS/etc is connected
  2. If not connected, agent calls open_provider_settings to open browser
  3. User completes OAuth flow in browser
  4. Agent calls check_provider_connection again to verify

§Deployment Flow

  1. Agent calls list_deployment_configs to see available deployment configs
  2. Agent calls trigger_deployment with project_id and config_id
  3. Agent calls get_deployment_status with task_id to monitor progress
  4. Agent calls list_deployments to see deployment history and public URLs
  5. Agent calls get_service_logs to 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§

AnalyzeCodebaseTool
Tool to perform comprehensive codebase analysis
AnalyzeProjectTool
Tool to analyze a project directory for deployment
CheckProviderConnectionTool
Tool to check if a cloud provider is connected to a project
CreateDeploymentConfigTool
Tool to create a new deployment configuration
CurrentContextTool
Tool to get the currently selected project context
DeployServiceTool
Tool to analyze a project and deploy it with intelligent recommendations
GetDeploymentStatusTool
Tool to get deployment task status
GetServiceLogsTool
Tool to get container logs for a deployed service
ListDeploymentCapabilitiesTool
Tool to list available deployment capabilities for a project
ListDeploymentConfigsTool
Tool to list deployment configurations for a project
ListDeploymentsTool
Tool to list recent deployments for a project
ListOrganizationsTool
Tool to list all organizations the authenticated user belongs to
ListProjectsTool
Tool to list all projects within an organization
OpenProviderSettingsTool
Tool to open the cloud providers settings page in the browser
ProvisionRegistryTool
Tool to provision a new container registry
SelectProjectTool
Tool to select a project as the current context
TriggerDeploymentTool
Tool to trigger a deployment using a deployment config