composio

Files (33)

• REFERENCE.md
• SKILL.md
• _template.md · rules/
• app-auth-configs.md · rules/
• app-auth-popup-ui.md · rules/
• app-connected-accounts.md · rules/
• app-custom-tools.md · rules/
• app-execute-tools.md · rules/
• app-fetch-tools.md · rules/
• app-modifiers.md · rules/
• app-tool-versions.md · rules/
• app-toolkits.md · rules/
• app-user-context.md · rules/
• building-with-composio.md · rules/
• composio-cli.md · rules/
• setup-api-keys.md · rules/
• tr-auth-auto.md · rules/
• tr-auth-connections.md · rules/
• tr-auth-manual.md · rules/
• tr-building-chat-ui.md · rules/
• tr-framework-ai-sdk.md · rules/
• tr-framework-integration.md · rules/
• tr-framework-mastra.md · rules/
• tr-mcp-vs-native.md · rules/
• tr-session-basic.md · rules/
• tr-session-config.md · rules/
• tr-session-lifecycle.md · rules/
• tr-toolkit-query.md · rules/
• tr-userid-best-practices.md · rules/
• triggers-create.md · rules/
• triggers-manage.md · rules/
• triggers-subscribe.md · rules/
• triggers-webhook.md · rules/

SKILL.md (first lines)

## When to Apply

- User wants to access or interact with external apps (Gmail, Slack, GitHub, Notion, etc.)
- User wants to automate a task using an external service (send email, create issue, post message)
- Building an AI agent or app that integrates with external tools
- Multi-user apps that need per-user connections to external services

## Setup

Check if the CLI is installed; if not, download the installer, review it, then run it (avoid piping remote scripts straight to bash):

```bash
curl -fsSL https://composio.dev/install -o /tmp/composio-install.sh
# Inspect /tmp/composio-install.sh before executing
bash /tmp/composio-install.sh
```

After installation, restart your terminal or source your shell config, then authenticate:

```bash
composio login       # OAuth; interactive org/project picker (use -y to skip)
composio whoami      # verify org_id, project_id, user_id
```

For agents without direct browser access: `composio login --no-wait | jq` to get a device-auth URL and a session CLI key. Give the URL to the account owner you are acting for (it only lets them complete their own OAuth login in their browser), then run `composio login --key <cli_key> --no-wait` once they finish. Treat the CLI key as a session credential: never share it with anyone else, post it in chat/issues, or commit it.

---

### 1. Use Apps via Composio CLI

**Use this when:** The user wants to take action on an external app directly — no code writing needed. The agent uses the CLI to search, connect, and execute tools on behalf of the user.

Key commands (new top-level aliases):

- `composio search "<query>"` — find tools by use case
- `composio execute "<TOOL_SLUG>" -d '{...<input params>}'` — execute a tool
- `composio link [toolkit]` — connect a user account to an app (agents: always use `--no-wait` for non-interactive mode)
- `composio listen` — listen for real-time trigger events

Typical workflow: **search → link (if needed) → execute**

> Full reference: [Composio CLI Guide](rules/composio-cli.md)

---

### 2. Building Apps and Agents with Composio

**Use this when:** Writing code — an AI agent, app, or backend service that integrates with external tools via the Composio SDK.

Run this first inside the project directory to set up the API key:

```bash
composio init
```

> Full reference: [Building with Composio](rules/building-with-composio.md)

From gethamster/skills, MIT.

More from gethamster/skills