Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

next
ts 81 lines 3.52 KB
Raw
1 import type { ReferenceDocument } from '../reference-schema';
2
3 export const composioDevReference: ReferenceDocument = {
4 slug: 'composio-dev',
5 title: 'Composio Dev',
6 intro: [
7 'Load this file only when the user explicitly needs developer-project workflows. Do not lead with `composio dev` for ordinary top-level CLI usage.',
8 ],
9 sections: [
10 {
11 title: 'Use `dev init` To Bind A Directory',
12 body: [
13 'Use `composio dev init` when the user wants to attach the current directory to a developer project.',
14 'If later commands complain about missing developer project context, come back to `dev init`.',
15 ],
16 commands: [{ code: 'composio dev init -y --no-browser' }],
17 },
18 {
19 title: 'Run Tools In A Developer Project',
20 body: [
21 'Top-level `composio execute` and `composio link` act on your own account, in your consumer project. To run a tool inside a developer project, as its playground test user or the user given by `--user-id`, use `composio dev playground-execute`. It takes the same `-d`, `--get-schema`, and `--dry-run` flags as `execute`.',
22 'If it reports that the toolkit is not connected for that user, connect it with `composio dev connected-accounts link <toolkit>`, then retry.',
23 ],
24 commands: [
25 {
26 code: 'composio dev playground-execute GMAIL_SEND_EMAIL --get-schema\ncomposio dev playground-execute GMAIL_SEND_EMAIL -d \'{ recipient_email: "a@b.com", subject: "Hello", body: "World" }\'\ncomposio dev connected-accounts link gmail',
27 },
28 ],
29 },
30 {
31 title: 'Inspect Toolkits And Versions',
32 body: ['Use toolkit commands to inspect developer-scoped capabilities:'],
33 commands: [
34 {
35 code: 'composio dev toolkits list\ncomposio dev toolkits info github\ncomposio dev toolkits search "email"\ncomposio dev toolkits version github',
36 },
37 ],
38 },
39 {
40 title: 'Manage Auth Configs',
41 body: [
42 'Use auth-config commands when the user is configuring developer-project authentication behavior:',
43 ],
44 commands: [{ code: 'composio dev auth-configs list' }],
45 },
46 {
47 title: 'Manage Connected Accounts',
48 body: [
49 'Use developer connected-account commands when the user is working with developer-project users or auth-config-specific flows.',
50 'Top-level `composio link` is consumer-only. Use `dev connected-accounts link` for developer-project flows.',
51 ],
52 commands: [{ code: 'composio dev connected-accounts list' }],
53 },
54 {
55 title: 'Work With Triggers',
56 body: [
57 'Use trigger commands when the user is creating, inspecting, or listening to developer-project triggers.',
58 ],
59 commands: [
60 {
61 code: 'composio dev triggers list\ncomposio dev triggers info AGENT_MAIL_NEW_EMAIL_TRIGGER',
62 },
63 ],
64 },
65 {
66 title: 'Inspect Logs',
67 body: [
68 'Use logs when the user is debugging tool executions or trigger deliveries inside a developer project.',
69 ],
70 commands: [{ code: 'composio dev logs tools\ncomposio dev logs triggers' }],
71 },
72 {
73 title: 'Switch Or Inspect Org And Project Context',
74 body: [
75 'Use these commands when the user needs to confirm or change the active developer scope:',
76 'If the user wants to act on their own account rather than in a developer project, return to the top-level workflow instead of staying in `composio dev`.',
77 ],
78 commands: [{ code: 'composio orgs list\ncomposio dev projects list' }],
79 },
80 ],
81 };