@devries-cameron20 / composio-1 / commits / 02a0dd96a
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.

docs: reorganize meta files

- Move planning docs to .claude/decisions/ - Merge CONTRIBUTING.md into README.md - Add examples.md (from user interviews) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Sushmithamallesh committed Jan 6, 2026 at 19:30 UTC 02a0dd96a983ab69e68a04b979700a907d23a6c6
4 files changed +169 -202
fumadocs/.claude/decisions/examples.md new
+134
@@ -0,0 +1,134 @@
1 +# Examples Page Plan
2 +
3 +Based on user interview analysis from #user-interviews Slack channel (50 use cases extracted).
4 +
5 +## Structure
6 +
7 +### Getting started
8 +| Example | What it demonstrates |
9 +|---------|---------------------|
10 +| Hello, world | First tool execution, basic setup |
11 +| Connect your first app in 60 seconds | OAuth flow, connected accounts |
12 +
13 +### Guides
14 +| Example | What it demonstrates |
15 +|---------|---------------------|
16 +| Building a Chat Agent | Core agentic loop, conversation context |
17 +| Building a RAG Agent | Tool router + knowledge retrieval |
18 +| Building a Slackbot Agent | Real-time messaging, event handling |
19 +| Building a Natural Language Data Analysis Agent | Complex queries, structured output |
20 +| Get started with Claude Code | MCP setup, Claude integration |
21 +| Get started with OpenAI Agents SDK | Native tools with OpenAI |
22 +| Get started with Vercel AI SDK | Streaming, Next.js integration |
23 +| Get started with LangChain | LangChain tools wrapper |
24 +| Get started with Mastra | Mastra framework integration |
25 +| Get started with CrewAI | Multi-agent with CrewAI |
26 +
27 +### Agents
28 +| Example | What it demonstrates |
29 +|---------|---------------------|
30 +| Build a PR review agent with GitHub and Claude | Multi-tool (GitHub + AI), code context |
31 +| Deploy an email assistant that drafts responses | Email integration, response generation |
32 +| Create a Slack bot with access to 250+ tools | Tool router, many toolkits |
33 +| Run a research agent that searches, scrapes, and summarizes | Web tools, chaining outputs |
34 +| Build an AI SDR that enriches leads automatically | CRM + web research, data enrichment |
35 +| Build an agentic RAG agent over your docs | RAG + tool calling combined |
36 +| Build a data analysis agent with natural language queries | Database tools, natural language to SQL |
37 +| Build a voice agent with real-time tool calling | Voice + tools, real-time streaming |
38 +| Spawn sub-agents for parallel task execution | Sub-agents, parallel processing |
39 +| Orchestrate multiple agents on a complex workflow | Multi-agent coordination, handoffs |
40 +| SEO data retrieval agent | Specialized data APIs, reporting |
41 +
42 +### Code & DevOps
43 +| Example | What it demonstrates |
44 +|---------|---------------------|
45 +| Auto-triage GitHub issues and assign owners | GitHub API, classification, automation |
46 +| Sync Linear tickets to Slack on status change | Cross-tool sync, webhooks |
47 +| Post CI failure summaries to Discord | CI integration, notifications |
48 +| Create Jira tickets from Slack messages | Slack → Jira, message parsing |
49 +
50 +### Communication & Social
51 +| Example | What it demonstrates |
52 +|---------|---------------------|
53 +| Send personalized emails at scale with Gmail | Bulk operations, personalization |
54 +| Build a Discord bot that manages your server | Discord API, bot commands |
55 +| Auto-respond to Slack DMs with context | Slack events, contextual responses |
56 +| LinkedIn content strategy agent | LinkedIn API, content generation |
57 +
58 +### Sales & CRM
59 +| Example | What it demonstrates |
60 +|---------|---------------------|
61 +| HubSpot CRM automation: new lead → research → enrich | CRM integration, data enrichment pipeline |
62 +
63 +### Productivity & Data
64 +| Example | What it demonstrates |
65 +|---------|---------------------|
66 +| Sync databases to Google Sheets automatically | Database + Sheets, data sync |
67 +| Build a meeting notes → Notion pipeline | Transcription + Notion, structured data |
68 +| Create calendar events from natural language | NLP input, calendar APIs |
69 +| Download attachments and process them | File download, file processing |
70 +| Turn documents into structured output | Document parsing, structured extraction |
71 +| Shopify sales reporting to Slack | E-commerce data, scheduled reports |
72 +
73 +### Triggers & Background jobs
74 +| Example | What it demonstrates |
75 +|---------|---------------------|
76 +| Build a Shopify customer support agent | E-commerce + support, always-on agent |
77 +| Run an agent when new emails arrive | Email triggers, event-driven |
78 +| Auto-review PRs on push | GitHub webhooks, automated review |
79 +| Daily digest: Summarize GitHub activity to Slack | Scheduled jobs, aggregation |
80 +| Weekly business report automation | Cron-style scheduling, multi-source data |
81 +| Webhook → process → route to the right tool | Generic webhooks, routing logic |
82 +
83 +---
84 +
85 +## Summary
86 +
87 +**Total: ~45 examples** across 8 categories
88 +
89 +## Design Notes
90 +
91 +- Style inspired by [Modal examples](https://modal.com/docs/examples) (domain categories, action-oriented naming)
92 +- "Get started with..." section inspired by [Vercel AI SDK cookbook](https://ai-sdk.dev/cookbook)
93 +- Framework (AI SDK, LangChain, etc.) shown as tabs within examples, not as primary categories
94 +- Advanced features (file upload/download, sub-agents) embedded in real use cases, not separate sections
95 +
96 +## Data Source
97 +
98 +- Google Sheet with all 50 use cases: https://docs.google.com/spreadsheets/d/16AH6LQyS5SZh2IezvwJptEGjR-LwLt0YfLEvtfqq94o/edit
99 +- Extracted from Slack #user-interviews channel (157 messages, 77 substantial)
100 +
101 +---
102 +
103 +## Future Plans
104 +
105 +### Featured Section
106 +- Add a hero grid at the top with 5 "wow" examples prominently displayed
107 +- Similar to Modal's featured examples
108 +
109 +### Templates
110 +- Pre-built starters users can clone
111 +- "AI Email Assistant Template"
112 +- "GitHub Bot Template"
113 +- "Slack Bot Template"
114 +
115 +### More Sales & CRM Examples
116 +- Salesforce automation
117 +- Deal tracking agent
118 +- Pipeline management agent
119 +
120 +### MCP-Specific Section
121 +- Connect Composio MCP to Claude Desktop
122 +- Use Composio MCP with Cursor
123 +- MCP setup with other clients
124 +- (This is a big entry point for users)
125 +
126 +### File Handling Example
127 +- Process uploaded PDFs and summarize them
128 +- Download attachments and analyze them
129 +- (Users mentioned this frequently in interviews)
130 +
131 +### Additional Examples to Match Modal Quality
132 +- Need ~20 more examples total
133 +- More specific, action-oriented naming
134 +- Cover edge cases and advanced patterns
fumadocs/.claude/decisions/toolkits.md renamed
fumadocs/CONTRIBUTING.md deleted
-114
@@ -1,114 +0,0 @@
1 -# Contributing to Composio Docs
2 -
3 -## Prerequisites
4 -
5 -- [Bun](https://bun.sh/) (v1.0+)
6 -- Node.js 18+
7 -
8 -## Getting Started
9 -
10 -### 1. Install dependencies
11 -
12 -```bash
13 -bun install
14 -```
15 -
16 -### 2. Run the dev server
17 -
18 -```bash
19 -bun run dev
20 -```
21 -
22 -The docs will be available at [http://localhost:3000](http://localhost:3000).
23 -
24 -### 3. Build for production
25 -
26 -```bash
27 -bun run build
28 -```
29 -
30 -## Project Structure
31 -
32 -```
33 -fumadocs/
34 -├── app/ # Next.js app router pages
35 -│ └── (home)/ # Main docs routes
36 -│ ├── docs/ # /docs section
37 -│ ├── tool-router/ # /tool-router section
38 -│ ├── examples/ # /examples section
39 -│ └── ...
40 -├── content/ # MDX content files
41 -│ ├── docs/ # Docs pages
42 -│ ├── tool-router/ # Tool Router pages
43 -│ ├── examples/ # Examples pages
44 -│ └── ...
45 -├── components/ # React components
46 -├── lib/ # Utilities and source config
47 -└── public/ # Static assets
48 -```
49 -
50 -## Adding/Editing Content
51 -
52 -### Adding a new page
53 -
54 -1. Create a new `.mdx` file in the appropriate `content/` folder
55 -2. Add frontmatter with `title` and `description`
56 -3. Add the page to the folder's `meta.json`
57 -
58 -Example:
59 -
60 -```mdx
61 ----
62 -title: My New Page
63 -description: A brief description
64 ----
65 -
66 -Your content here...
67 -```
68 -
69 -### Using components
70 -
71 -Common components available in MDX:
72 -
73 -```mdx
74 -<Tabs items={['Python', 'TypeScript']}>
75 - <Tab value="Python">Python code here</Tab>
76 - <Tab value="TypeScript">TypeScript code here</Tab>
77 -</Tabs>
78 -
79 -<Callout type="info">Important information</Callout>
80 -
81 -<Steps>
82 - <Step>### Step 1</Step>
83 - <Step>### Step 2</Step>
84 -</Steps>
85 -
86 -<Cards>
87 - <Card title="Title" href="/path" />
88 -</Cards>
89 -```
90 -
91 -## Sidebar Configuration
92 -
93 -Each content folder has a `meta.json` that controls sidebar order:
94 -
95 -```json
96 -{
97 - "title": "Section Title",
98 - "pages": [
99 - "---Section Header---",
100 - "page-one",
101 - "page-two",
102 - "nested-folder"
103 - ]
104 -}
105 -```
106 -
107 -## Common Commands
108 -
109 -| Command | Description |
110 -|---------|-------------|
111 -| `bun run dev` | Start dev server |
112 -| `bun run build` | Production build |
113 -| `bun run start` | Start production server |
114 -| `bun run types:check` | Type check |
fumadocs/README.md
+35 -88
@@ -1,126 +1,73 @@
1 # Composio Docs
2
3 -The official documentation site for Composio.
4 -
5 -## Tech Stack
6 -
7 -- **Framework**: [Next.js 16](https://nextjs.org/) (App Router)
8 -- **React**: React 19
9 -- **Documentation**: [Fumadocs](https://fumadocs.dev/)
10 -- **Content**: MDX (Markdown + JSX)
11 -- **Styling**: [Tailwind CSS v4](https://tailwindcss.com/)
12 -- **Language**: TypeScript 5.9
13 -- **Package Manager**: Bun
3 +Documentation site for Composio, built with [Fumadocs](https://fumadocs.dev/).
4
5 ## Getting Started
6
17 -### Prerequisites
18 -
19 -- Node.js 20+
20 -- [Bun](https://bun.sh/) (recommended) or npm/pnpm/yarn
21 -
22 -### Installation
23 -
7 ```bash
25 -# Clone the repository
26 -git clone https://github.com/composio
27 -cd docs
28 -
29 -# Install dependencies
8 bun install
31 -
32 -# Start development server
9 bun run dev
10 ```
11
36 -Open [http://localhost:3000/docs](http://localhost:3000/docs) to view the documentation.
12 +Open [http://localhost:3000](http://localhost:3000).
13
14 ## Project Structure
15
16 ```
17 +fumadocs/
18 ├── app/ # Next.js app router
42 -│ ├── (home)/ # Landing page
43 -│ ├── docs/ # Documentation layout & pages
44 -│ └── api/search/ # Search API endpoint
45 -├── content/
46 -│ └── docs/ # Documentation content (MDX files)
47 -├── lib/
48 -│ ├── source.ts # Content source configuration
49 -│ └── layout.shared.tsx # Shared layout options
50 -└── source.config.ts # Fumadocs MDX configuration
19 +├── content/ # MDX content
20 +│ ├── docs/
21 +│ ├── examples/
22 +│ ├── changelog/
23 +│ └── reference/
24 +├── components/ # React components
25 +├── lib/ # Utilities
26 +└── public/ # Static assets
27 ```
28
53 -## Adding Documentation
54 -
55 -### Create a new page
29 +## Adding Content
30
57 -Add an MDX file to `content/docs/`:
31 +Create an `.mdx` file in `content/`, add frontmatter, then add to `meta.json`:
32
33 ```mdx
34 ---
61 -title: Your Page Title
62 -description: A brief description
35 +title: Page Title
36 +description: Brief description
37 ---
38
65 -Your content here...
39 +Content here...
40 ```
41
68 -### Create a section
69 -
70 -Create a folder with an `index.mdx`:
42 +### Components
43
72 -```
73 -content/docs/
74 -└── guides/
75 - ├── index.mdx # Section landing page
76 - ├── getting-started.mdx
77 - └── advanced.mdx
78 -```
79 -
80 -### Available Components
44 +```mdx
45 +<Tabs items={['Python', 'TypeScript']}>
46 + <Tab value="Python">...</Tab>
47 + <Tab value="TypeScript">...</Tab>
48 +</Tabs>
49
82 -Fumadocs provides built-in components you can use in MDX:
50 +<Callout type="info">Note</Callout>
51
84 -```mdx
52 <Cards>
86 - <Card title="Title" href="/docs/page" description="Description" />
53 + <Card title="Title" href="/path" />
54 </Cards>
88 -
89 -<Callout type="info">
90 - Important information here
91 -</Callout>
55 ```
56
94 -## Contributing
95 -
96 -We welcome contributions! Here's how to help:
57 +### Sidebar
58
98 -### Content Contributions
59 +Each folder has `meta.json` for ordering:
60
100 -1. Fork the repository
101 -2. Create a branch: `git checkout -b docs/your-topic`
102 -3. Add or edit MDX files in `content/docs/`
103 -4. Submit a pull request
104 -
105 -### Code Contributions
106 -
107 -1. Fork the repository
108 -2. Create a branch: `git checkout -b feature/your-feature`
109 -3. Make your changes
110 -4. Run `bun run build` to verify the build passes
111 -5. Submit a pull request
112 -
113 -### Guidelines
114 -
115 -- Keep documentation clear and concise
116 -- Use proper headings hierarchy (h2, h3, etc.)
117 -- Include code examples where helpful
118 -- Test your changes locally before submitting
61 +```json
62 +{
63 + "pages": ["page-one", "page-two"]
64 +}
65 +```
66
120 -## Scripts
67 +## Commands
68
69 | Command | Description |
70 |---------|-------------|
124 -| `bun run dev` | Start development server |
125 -| `bun run build` | Build for production |
126 -| `bun run start` | Start production server |
71 +| `bun run dev` | Dev server |
72 +| `bun run build` | Production build |
73 +| `bun run types:check` | Type check |