@devries-cameron20 / composio Mirror · read-only
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 21, 03:37 UTC

next
md 195 lines 7.33 KB
Rendered Raw
1 # Cookbooks Complete Revamp — Task Tracker
2
3 **Goal:** Transform cookbooks into a use-case-driven section with scannable card overview, concise dual-language examples, problem-first framing, and a Modal-inspired index page. All code uses the `session.create` paradigm exclusively.
4
5 ---
6
7 ## Phase 1: Foundation & Structure
8
9 ### 1.0 Rename Examples → Cookbooks ✅
10
11 - [x] Renamed `content/examples/` → `content/cookbooks/`
12 - [x] Updated all source configs, routes, nav, search, LLM endpoints, sitemap
13 - [x] Added `/examples/` → `/cookbooks/` permanent redirects
14 - PR #2638 (merged)
15
16 ### 1.1 Review & Update Provider Pages
17
18 **LLM Guardrails** ✅
19
20 - [x] Session guardrails (default, ~1100+ pages)
21 - [x] Direct execution guardrails (12 tagged pages)
22 - [x] Pipeline injection via `getLLMText()`
23 - [x] `llms-full.txt` and `llms.txt` updated
24
25 **Existing Providers (review & update)** ✅
26
27 - [x] `openai.mdx` — Responses API + Chat Completions
28 - [x] `anthropic.mdx` — Messages API, Steps pattern
29 - [x] `google.mdx` — Chat API, Steps pattern
30 - [x] `vercel.mdx` — Native tools only, Steps pattern
31 - [x] `langchain.mdx` — PR #2651
32 - [x] `llamaindex.mdx` — PR #2651
33 - [x] `mastra.mdx` — PR #2651
34 - [x] `crewai.mdx` — PR #2651 + PR #2650 (strict mode fix)
35 - [x] `openai-agents.mdx` — PR #2651
36
37 **New Providers (write from scratch)**
38
39 - [x] `claude-agent-sdk.mdx` — Python + TS (PR #2651)
40 - [x] `autogen.mdx` — Python only (PR #2651, SDK has broken imports — PLEN-1603)
41 - [x] `google-adk.mdx` — Python only (PR #2651)
42 - [ ] `langgraph.mdx` — Python only (not started)
43 - [x] Providers index page with card grid (PR #2655)
44 - Cloudflare removed (PLEN-1602 for e2e testing)
45
46 **PRs:**
47
48 - #2651 — Providers revamp (merged into next)
49 - #2655 — Providers index page + reorder
50 - #2650 — CrewAI strict mode fix
51 - #2647 — LangChain serialization fix
52
53 **Linear Tickets:**
54
55 - PLEN-1602 — Cloudflare e2e testing
56 - PLEN-1603 — AutoGen broken imports
57
58 ### 1.2 Move existing cookbooks to guides/ subfolder — DEFERRED
59
60 - [ ] Move `fast-api`, `hono`, `slack-summariser`, `vercel-chat`, `tool-generator` to `content/cookbooks/guides/`
61 - [ ] Delete `gmail-labeler.mdx` and `supabase-sql-agent.mdx`
62 - [ ] Add redirects
63 - Deferred until after Phase 2
64
65 ### 1.3 Rewrite cookbooks meta.json — DEFERRED
66
67 - [ ] New category structure (Code & DevOps, Communication, Sales, Research, etc.)
68 - Deferred until after Phase 2
69
70 ### 1.4 Create "Use Composio With" section — DEFERRED
71
72 - [ ] chatgpt, agent-builder, claude-desktop, claude-code, cursor, vscode, mcp-url, n8n
73 - Deferred until after Phase 2
74
75 ### 1.5 Rewrite cookbooks index page — DEFERRED
76
77 - [ ] Card-grid overview inspired by Modal
78 - Deferred until after Phase 2
79
80 ---
81
82 ## Phase 2: Write New Use-Case Cookbooks
83
84 **Template for each cookbook:**
85
86 - Title + 1-paragraph description
87 - What You'll Build (2-3 bullets)
88 - Prerequisites (API keys, connected accounts)
89 - Implementation (code in files, imported via include)
90 - How It Works
91 - Next Steps
92
93 **Key rules:**
94
95 - All code uses `session.create` paradigm exclusively
96 - No auth boilerplate — link to `/docs/authentication`
97 - Code lives in `docs/cookbooks/{name}/` directory, imported into MDX via include
98 - Action-oriented titles
99
100 ### Priority 1 (highest impact)
101
102 - [x] `chat-app` — Build a Chat App (PR #2728, branch: `docs/chat-app-1`)
103 - [ ] `slack-bot` — Build a Slack Bot (Vercel AI SDK + Composio)
104 - [x] `pr-review-agent` — PR review agent (PR #2832, branch: `docs/pr-review-agent-cookbook`, OpenAI Agents SDK, reads CLAUDE.md/AGENTS.md, includes GitHub Action)
105 - [x] `gmail-auto-labeler` — Already exists as `gmail-labeler` cookbook
106 - [x] `slack-summarizer` — Already exists as `slack-summariser` cookbook
107 - [ ] `mcp-setup` — Connect Composio Tools via MCP
108 - [ ] `research-agent` — Build a Research Agent (Web Search, Scraping)
109
110 ### Priority 2
111
112 - [ ] `lead-enrichment` — Build a Lead Enrichment Agent (HubSpot, Web)
113 - [ ] `email-at-scale` — Send Personalized Emails at Scale (Gmail)
114 - [ ] `issue-triage` — Auto-Triage GitHub Issues (GitHub)
115 - [ ] `meeting-notes-to-notion` — Sync Meeting Notes to Notion (Notion)
116 - [ ] `sheets-sync` — Sync Data to Google Sheets (Google Sheets)
117
118 ### Priority 3
119
120 - [ ] `email-trigger-agent` — Run an Agent on New Emails (Gmail, Triggers)
121 - [ ] `daily-digest` — Daily GitHub Digest to Slack (GitHub, Slack)
122 - [ ] `calendar-agent` — Create Calendar Events from Natural Language (Google Calendar)
123 - [ ] `ci-failure-notifier` — Post CI Failures to Discord (GitHub, Discord)
124 - [ ] `social-posting` — Social Media Content Agent (LinkedIn, Twitter)
125 - [ ] `voice-agent` — Build a Voice Agent with Tool Calling (Voice, TBD)
126
127 ---
128
129 ## Phase 3: Write Framework Cookbooks
130
131 Full-stack templates live as cloneable repos on GitHub. Docs pages describe what the template does, show key snippets, and link to the repo.
132
133 ### TypeScript Frameworks
134
135 - [ ] `express.mdx`
136 - [ ] `fastify.mdx`
137 - [ ] `hono.mdx`
138 - [ ] `nextjs.mdx`
139 - [ ] `nestjs.mdx`
140 - [ ] `nuxt.mdx`
141 - [ ] `sveltekit.mdx`
142 - [ ] `node-http.mdx`
143
144 ### Python Frameworks
145
146 - [ ] `fastapi.mdx`
147 - [ ] `flask.mdx`
148 - [ ] `django.mdx`
149
150 ---
151
152 ## Phase 4: Polish
153
154 - [ ] Run `bun run build` to validate all TypeScript code blocks
155 - [ ] Test mobile layout
156 - [ ] Verify all cross-links work
157 - [ ] Update `decisions/examples.md` with status
158
159 ---
160
161 ## Phase 5: Revamp Cookbooks Index Page
162
163 - [ ] Visual card grid with categories (Modal-inspired)
164 - [ ] Each card: title, short description, toolkit tags
165 - [ ] Featured/popular section at top
166 - [ ] Update incrementally as cookbooks are added
167
168 ---
169
170 ## Decisions & Notes
171
172 - Code files live at `docs/examples/{cookbook-name}/` (excluded from tsconfig, type-checked by twoslash via `<include>`)
173 - MDX pages use fumadocs `<include>` component to import code from files
174 - Cookbooks link to GitHub source: `github.com/ComposioHQ/composio/tree/next/docs/examples/{name}`
175 - Tools count is now 1000+ (not 250+)
176 - Phase 1.2–1.5 deferred until after Phase 2 for continuous shipping
177 - Twoslash JSX fix: added `jsx: ReactJSX` + `jsxImportSource: react` to twoslash compilerOptions in source.config.ts (global fix for all TSX code blocks)
178 - `examples/` excluded from tsconfig.json (twoslash handles type-checking via `<include>`, Next.js `tsc` can't resolve local relative imports)
179 - Welcome page revamped: hero cards (Tutorial + How it works), full-width Quickstart, AIToolsBanner component, Explore section
180 - AIToolsBanner component has markdown fallback in `lib/source.ts` for LLM crawlers
181 - The legacy `docs/examples/` sample-code folder (14 standalone app folders) was removed — it was orphaned (not referenced by any `content/examples` `<include>`, the source config, or the `llms.txt`/`llms-full.txt` routes). The live `/examples` page is sourced from `content/examples/`.
182
183 ---
184
185 ## Summary
186
187 | Phase | Status |
188 | ------------------------------- | ---------------------------------- |
189 | 1.0 Rename Examples → Cookbooks | ✅ Done |
190 | 1.1 Provider Pages | ✅ Done (except `langgraph.mdx`) |
191 | 1.2–1.5 Structure & Index | Deferred |
192 | 2 Use-Case Cookbooks | In progress (4 done, 14 remaining) |
193 | 3 Framework Cookbooks | Not started (11 cookbooks) |
194 | 4 Polish | Not started |
195 | 5 Index Page Revamp | Not started |