Skip to Content
Apso is in public beta. Get started
GuidesToolsOverview

Tools and workflows

Start with the product outcome. A coding agent connected to Apso can inspect the project, apply Apso’s backend rules, choose the right tools, and verify the result. The CLI and SDK remain available when you want to run each step directly.

Agent workflowTurn your coding agent into a backend expert with Apso.
Skills + MCP
You

“Add team invitations with owner and admin roles. Explain the tenant boundary, then build and test the workflow.”

Apso contextProduct rulesSchema referenceProject-aware toolsSafety boundaries
  1. 01
    InspectRead the current project and schema.
  2. 02
    ModelPropose entities, scope, and permissions.
  3. 03
    GenerateBuild from the validated contract.
  4. 04
    VerifyRun migrations, tests, and one real workflow.
Ask for the product outcome. The agent can choose the Apso tools and show its backend decisions before it changes the project.

Ask for the outcome

Give the agent the actors, resources, permissions, and workflow you need. Ask it to explain the model and migration risk before it changes the project.

Example request
Add team invitations to this service. Owners and admins can invite members. An invitation expires after seven days and can only be accepted by the invited email address. Inspect the current schema, explain the tenant boundary, then generate and test the workflow.

The Apso MCP connection supplies the project schema, schema reference, operating rules, and tools. You do not need to translate the request into a sequence of CLI commands.

Connect a coding agent to Apso →

Choose the tool for the job

JobToolWhat it gives you
Design and change the backend with an agentApso skills and MCP serverProduct-aware schema design, validation, generation, diagnostics, and deployment tools
Create, inspect, generate, and run a service directlyApso CLIExplicit local commands and automation-friendly output
Call the generated API from TypeScriptApso SDKConfigured clients, fluent queries, mutations, and typed request code
Work against a local database and serviceLocal developmentA repeatable environment for generation, migration checks, and API testing
Review persisted schema changesMigrationsMigration previews, destructive-change review, and database updates
Prove the product behaviorTestingUnit, integration, API, and end-to-end checks

Run the loop directly

Use the CLI when you need an explicit command or a CI step.

# Create or link the project apso init --name my-api # Validate the product contract apso schema validate # Generate the selected framework apso generate # Review the database change apso migrate # Run the service locally apso dev

After generation, inspect the schema and generated diff before running framework checks. Keep custom behavior in the extension layer.

Connect through the SDK

lib/apso.ts
import { ApsoClientFactory } from '@apso/sdk' export const apso = ApsoClientFactory.getClient({ baseURL: process.env.APSO_API_URL!, apiKey: process.env.APSO_API_KEY! }) export function listActiveProjects() { return apso .entity('Projects') .where({ status: { $eq: 'Active' } }) .findMany() }

Keep service keys in server-side environment variables. Use an end-user session or token for browser and mobile requests.

Verify every change

  1. Confirm .apsorc still represents the intended product behavior.
  2. Validate before generation.
  3. Review generated source and migration diffs.
  4. Run the framework build and relevant tests.
  5. Exercise one authenticated product workflow.
  6. Confirm generated files were not edited by hand.

Run the full end-to-end workflow →

Last updated on