@devries-cameron20 / composio Mirror · read-only / commits / aac81fdeb
Fork 0

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

Mirrored from https://github.com/Camo67/composio.git

Synced Nov 22, 04:30 UTC

ci: add daily sync for Connect clients from dashboard repo

Adds a Claude Code GitHub Action that runs daily at 8 AM UTC to sync client definitions from ComposioHQ/composio_dashboard to the Composio Connect docs page. Creates a PR if any clients, steps, or logos changed. - .github/workflows/docs.sync-connect-clients.yml - cron + manual trigger - docs/.claude/agents/connect-clients-sync.md - agent instructions Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Sushmitha Mallesh committed Mar 6, 2026 at 17:26 UTC aac81fdeb9a7928fe66b95223e0ce5dbe468217a
2 files changed +185
.github/workflows/docs.sync-connect-clients.yml new
+67
@@ -0,0 +1,67 @@
1 +name: Docs - Sync Connect Clients
2 +
3 +on:
4 + schedule:
5 + - cron: '0 8 * * *'
6 + workflow_dispatch:
7 +
8 +jobs:
9 + sync-clients:
10 + runs-on: ubuntu-latest
11 + timeout-minutes: 30
12 + permissions:
13 + contents: write
14 + pull-requests: write
15 + id-token: write
16 +
17 + steps:
18 + - name: Checkout repository
19 + uses: actions/checkout@v6
20 + with:
21 + fetch-depth: 1
22 +
23 + - name: Sync Connect clients
24 + uses: anthropics/claude-code-action@v1
25 + with:
26 + anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
27 + direct_prompt: |
28 + Sync the Composio Connect clients page from the dashboard repo.
29 +
30 + 1. Read docs/.claude/agents/connect-clients-sync.md for full instructions
31 + 2. Fetch the client definitions from ComposioHQ/composio_dashboard (main branch):
32 + src/app/(connect)/[org]/~/connect/clients/_components/client-definitions.ts
33 + 3. Read the current docs/content/docs/composio-connect.mdx
34 + 4. Compare and update if there are any differences (new clients, changed steps, updated descriptions)
35 + 5. Download any new client logos to docs/public/images/clients/
36 + 6. If no changes are needed, make no file changes
37 +
38 + - name: Create PR if changed
39 + env:
40 + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
41 + run: |
42 + if [ -z "$(git status --porcelain)" ]; then
43 + echo "No changes detected"
44 + exit 0
45 + fi
46 +
47 + BRANCH="docs/auto-sync-connect-clients-$(date +%Y%m%d)"
48 + git config user.name "github-actions[bot]"
49 + git config user.email "github-actions[bot]@users.noreply.github.com"
50 + git checkout -b "$BRANCH"
51 + git add -A
52 + git commit -m "docs: sync Connect clients from dashboard"
53 + git push -u origin "$BRANCH"
54 +
55 + gh pr create \
56 + --base next \
57 + --head "$BRANCH" \
58 + --title "docs: Sync Connect clients from dashboard" \
59 + --body "$(cat <<'EOF'
60 + ## Summary
61 + Automated sync of AI client definitions from `ComposioHQ/composio_dashboard`.
62 +
63 + Updates client setup steps, descriptions, and logos on the Composio Connect page.
64 +
65 + Generated by Claude Code via GitHub Actions.
66 + EOF
67 + )"
docs/.claude/agents/connect-clients-sync.md new
+118
@@ -0,0 +1,118 @@
1 +# Connect Clients Sync
2 +
3 +Syncs AI client definitions from the dashboard repo (`ComposioHQ/composio_dashboard`) to the Composio Connect docs page.
4 +
5 +## When This Runs
6 +
7 +Runs daily at 8 AM UTC via cron, or manually via workflow_dispatch. Creates a PR if client definitions have changed.
8 +
9 +## Source of Truth
10 +
11 +The dashboard repo's client definitions file:
12 +```
13 +ComposioHQ/composio_dashboard
14 +src/app/(connect)/[org]/~/connect/clients/_components/client-definitions.ts
15 +```
16 +
17 +This file contains the `ALL_CLIENTS` array with every client's:
18 +- `id`, `name`, `description`, `icon`, `category`
19 +- `authMethods` with step-by-step setup instructions
20 +- Auth types: `oauth` and/or `api-key`
21 +
22 +## Target File
23 +
24 +```
25 +docs/content/docs/composio-connect.mdx
26 +```
27 +
28 +## Process
29 +
30 +1. Fetch `client-definitions.ts` from `ComposioHQ/composio_dashboard` (main branch) using the GitHub API
31 +2. Read the current `docs/content/docs/composio-connect.mdx`
32 +3. Compare the client list, categories, and setup steps
33 +4. If there are differences, update `composio-connect.mdx` to match the dashboard
34 +
35 +## MDX Structure
36 +
37 +The page uses `<ConnectFlow>` and `<ConnectClientOption>` components:
38 +
39 +```mdx
40 +<ConnectFlow>
41 +
42 +<ConnectClientOption id="client-id" name="Client Name" description="..." icon="/images/clients/logo.svg" category="popular|ide|other">
43 +
44 +<Steps>
45 +<Step>
46 +<StepTitle>Step title</StepTitle>
47 +
48 +Step description.
49 +
50 +</Step>
51 +</Steps>
52 +
53 +</ConnectClientOption>
54 +
55 +</ConnectFlow>
56 +```
57 +
58 +### Category Mapping
59 +
60 +Only these 4 clients should have `category="popular"` (shown as tabs):
61 +- `claude-code`
62 +- `codex`
63 +- `openclaw`
64 +- `claude-desktop`
65 +
66 +All other clients go in the dropdown:
67 +- Dashboard `IDEs` category → `category="ide"`
68 +- Everything else → `category="other"`
69 +
70 +### Auth Method Selection
71 +
72 +For the docs page, use the **API key** auth method steps when available. For OAuth-only clients (like Claude Desktop, ChatGPT), use the OAuth steps.
73 +
74 +For API key clients, always prepend this step before the client-specific steps:
75 +
76 +```mdx
77 +<Step>
78 +<StepTitle>Get your API key</StepTitle>
79 +
80 +Open the [Composio dashboard](https://dashboard.composio.dev) and click **AI Clients** in the sidebar. Select your client and copy your API key.
81 +
82 +</Step>
83 +```
84 +
85 +### Code Blocks
86 +
87 +- Use `YOUR_API_KEY` as the placeholder (not the `${token}` variable from the dashboard)
88 +- Use `https://connect.composio.dev/mcp` as the MCP URL (not the `${MCP_URL}` variable)
89 +- Detect the correct language: `bash` for CLI commands, `toml` for TOML config, `json` for JSON config, `text` for plain text/prompts
90 +- Include the `title` attribute from the dashboard's `label` field when present
91 +
92 +### Client Logos
93 +
94 +Client logos live in `docs/public/images/clients/`. If a new client is added in the dashboard, download its logo from the dashboard repo. The dashboard stores logos at:
95 +- `public/images/clients/`
96 +- `public/images/logos/`
97 +
98 +Save all logos to `docs/public/images/clients/` and reference them as `/images/clients/filename.ext` in the MDX.
99 +
100 +### Client Order
101 +
102 +Popular tab clients come first (in the order listed above), then other clients in the order they appear in the dashboard's `ALL_CLIENTS` array.
103 +
104 +## What NOT to Change
105 +
106 +- Do NOT modify the frontmatter (title, description) unless new clients need to be added to keywords
107 +- Do NOT modify the intro text ("Give any AI agent...")
108 +- Do NOT modify the "Connect your apps" section at the bottom
109 +- Do NOT modify `connect-flow.tsx` or other component files
110 +- Do NOT modify `source.ts` or `mdx-components.tsx`
111 +
112 +## Rules
113 +
114 +- Only modify `docs/content/docs/composio-connect.mdx` and files in `docs/public/images/clients/`
115 +- Match the exact step text from the dashboard (resolve template variables like `${MCP_URL}` and `${token}`)
116 +- If a client has `comingSoon: true` in the dashboard, skip it
117 +- If no changes are needed, make no file changes
118 +- Keep the `keywords` frontmatter array updated with all client names (lowercase)