Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

amodal pkg connect & sync

connect

Add a connection to your agent. Connections give the agent API access and documentation for external systems.

# Install a pre-built plugin
amodal pkg connect slack
amodal pkg connect datadog
amodal pkg connect github
 
# List available plugins
amodal pkg search --tag connection

This installs the plugin package into node_modules. The resolver automatically surfaces its connections, skills, knowledge, and other contents alongside your local files.

sync

Sync API specifications from remote sources. Useful for custom APIs or keeping specs up to date.

# Sync from an OpenAPI spec
amodal pkg sync --from https://api.example.com/openapi.json
 
# Sync from a GraphQL schema
amodal pkg sync --from https://api.example.com/graphql
 
# Check for drift without updating (useful in CI)
amodal pkg sync --check

Drift Detection

The --check flag compares your local specs against the remote source and reports differences without making changes. This is useful in CI pipelines to catch API changes early.

Connection Structure

Each connection directory contains:

connections/slack/
├── spec.json       ← endpoints, auth config, entity list
├── access.json     ← field restrictions, action tiers, scoping rules
└── credentials     ← (gitignored) API keys, tokens

spec.json

Machine-readable configuration:

  • baseUrl — API base URL
  • specUrl — URL to the API spec document (optional)
  • auth — Authentication method (bearer, OAuth, API key)
  • sync — Sync configuration and filters

access.json

Security rules:

  • Field restrictions — which fields are readable/writable
  • Action tiers — confirm/review/never for different operations
  • Scoping rules — app-level access control

Available Plugins

50+ pre-built connection plugins are available. Browse them in the Amodal Marketplace or see Connections for setup details.