@devries-cameron20 / composio Mirror · read-only / commits / b9e129f46
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, 23:15 UTC

updated prompts/claude.md for docs/sdk

balyan.sid@gmail.com committed Jun 30, 2025 at 15:33 UTC b9e129f463ff934fd449f02b3e9c6af34f736729
3 files changed +290 -1
.github/workflows/claude-code-doc-review.yml new
+70
@@ -0,0 +1,70 @@
1 +name: Claude Code Review
2 +
3 +on:
4 + pull_request:
5 + types: [ opened, synchronize ]
6 + # Optional: Only run on specific file changes
7 + paths:
8 + - "fern/pages/**/*.mdx"
9 +jobs:
10 + claude-review:
11 + # Optional: Filter by PR author
12 + # if: |
13 + # github.event.pull_request.user.login == 'external-contributor' ||
14 + # github.event.pull_request.user.login == 'new-developer' ||
15 + # github.event.pull_request.author_association == 'FIRST_TIME_CONTRIBUTOR'
16 +
17 + runs-on: ubuntu-latest
18 + permissions:
19 + contents: read
20 + pull-requests: read
21 + issues: read
22 + id-token: write
23 +
24 + steps:
25 + - name: Checkout repository
26 + uses: actions/checkout@v4
27 + with:
28 + fetch-depth: 1
29 +
30 + - name: Run Claude Code Review
31 + id: claude-review
32 + uses: anthropics/claude-code-action@beta
33 + with:
34 + anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
35 +
36 + # Optional: Specify model (defaults to Claude Sonnet 4, uncomment for Claude Opus 4)
37 + # model: "claude-opus-4-20250514"
38 +
39 + # Direct prompt for automated review (no @claude mention needed)
40 + direct_prompt: |
41 +
42 + Please review this pull request for documentation changes and provide feedback on:
43 + - Grammar and spelling
44 + - Clarity and readability
45 + - Consistency and tone
46 + - Proper adherence to the documentation style guide in `fern/CLAUDE.md`
47 +
48 + Be constructive and helpful in your feedback.
49 + # Optional: Customize review based on file types
50 + # direct_prompt: |
51 + # Review this PR focusing on:
52 + # - For TypeScript files: Type safety and proper interface usage
53 + # - For API endpoints: Security, input validation, and error handling
54 + # - For React components: Performance, accessibility, and best practices
55 + # - For tests: Coverage, edge cases, and test quality
56 +
57 + # Optional: Different prompts for different authors
58 + # direct_prompt: |
59 + # ${{ github.event.pull_request.author_association == 'FIRST_TIME_CONTRIBUTOR' &&
60 + # 'Welcome! Please review this PR from a first-time contributor. Be encouraging and provide detailed explanations for any suggestions.' ||
61 + # 'Please provide a thorough code review focusing on our coding standards and best practices.' }}
62 +
63 + # Optional: Add specific tools for running tests or linting
64 + allowed_tools: "Bash(*)"
65 +
66 + # Optional: Skip review for certain conditions
67 + # if: |
68 + # !contains(github.event.pull_request.title, '[skip-review]') &&
69 + # !contains(github.event.pull_request.title, '[WIP]')
70 +
CLAUDE.md
+103 -1
@@ -6,6 +6,10 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
6
7 This is the Composio SDK v3 repository containing both TypeScript and Python SDKs. The main development focus is on the TypeScript SDK located in `/ts/` directory. The project uses a monorepo structure with multiple packages and examples.
8
9 +## Memories and Notes
10 +
11 +- For documentation tasks, refer to `fern/CLAUDE.md`
12 +
13 ## Common Development Commands
14
15 ### Build and Development
@@ -205,4 +209,102 @@ const customTool = await composio.tools.createCustomTool({
209 });
210 ```
211
208 -This monorepo uses pnpm workspaces and Turbo for efficient builds and development.
\ No newline at end of file
212 +This monorepo uses pnpm workspaces and Turbo for efficient builds and development.
213 +
214 +## Python SDK Development
215 +
216 +### Setup
217 +The Python SDK is located in the `/python/` directory and uses `uv` for dependency management and `nox` for automation.
218 +
219 +### Environment Setup
220 +```bash
221 +# Create and setup Python development environment
222 +cd python
223 +make env
224 +source .venv/bin/activate
225 +```
226 +
227 +### Python Development Commands
228 +```bash
229 +# Setup environment (creates virtual env with all dependencies)
230 +make env
231 +
232 +# Sync dependencies (when in an existing environment)
233 +make sync
234 +
235 +# Install provider packages
236 +make provider
237 +
238 +# Format code using ruff
239 +make fmt
240 +# Or directly: nox -s fmt
241 +
242 +# Check linting and type issues
243 +make chk
244 +# Or directly: nox -s chk
245 +
246 +# Fix linting issues
247 +nox -s fix
248 +
249 +# Run tests (requires implementing tst session)
250 +make tst
251 +# Or directly: nox -s tst
252 +
253 +# Run sanity tests (requires implementing snt session)
254 +make snt
255 +# Or directly: nox -s snt
256 +
257 +# Clean build artifacts
258 +make clean-build
259 +
260 +# Bump version
261 +make bump
262 +
263 +# Build packages
264 +make build
265 +```
266 +
267 +### Python Project Structure
268 +```
269 +python/
270 +├── composio/ # Main SDK package
271 +├── providers/ # Provider implementations
272 +├── tests/ # Test suite
273 +├── examples/ # Usage examples
274 +├── scripts/ # Development scripts
275 +├── config/ # Configuration files
276 +│ ├── pytest.ini # Pytest configuration
277 +│ ├── mypy.ini # MyPy type checking config
278 +│ ├── ruff.toml # Ruff linter/formatter config
279 +│ └── codecov.yml # Code coverage config
280 +├── Makefile # Development shortcuts
281 +├── noxfile.py # Nox automation sessions
282 +└── pyproject.toml # Project configuration
283 +```
284 +
285 +### Python Code Quality
286 +- **Formatter**: Ruff (Black-compatible, 88 char line length)
287 +- **Linter**: Ruff with custom configuration
288 +- **Type Checker**: mypy with strict optional typing
289 +- **Test Framework**: pytest with custom markers (core, openai, langchain, agno)
290 +- **Python Version**: >=3.10, <4
291 +- **Dependency Managers**: uv
292 +
293 +### Python Testing
294 +```bash
295 +# Run tests with pytest markers
296 +pytest -m core # Run core tests only
297 +pytest -m openai # Run OpenAI provider tests
298 +pytest -m langchain # Run LangChain provider tests
299 +pytest -m agno # Run Agno provider tests
300 +```
301 +
302 +### Python Package Dependencies
303 +- Core: `pysher`, `pydantic>=2.6.4`, `composio-client==1.4.0`, `typing-extensions>=4.0.0`, `openai`
304 +- Dev: `nox`, `pytest`, `ruff`, `langchain_openai`, `fastapi`, `twine`, `click`, `semver`
305 +
306 +### Python Environment Variables
307 +Same as TypeScript SDK, with additional:
308 +```bash
309 +OPENAI_API_KEY # Required for OpenAI provider examples
310 +```
\ No newline at end of file
fern/CLAUDE.md
+117
@@ -0,0 +1,117 @@
1 +# CLAUDE.md
2 +
3 +You are reviewing technical documentation for the Composio SDK and API.
4 +
5 +Your task is to:
6 +- Catch and fix any and all grammar and spelling mistakes.
7 +- Find logical gaps in explanations that might make it difficult to understand a concept for a user.
8 +- Find and suggest fixes in ``` codeblocks when proper practices aren’t being followed.
9 +
10 +Read through the previous docs in `fern/pages/src` to understand how they are written.
11 +
12 +### Proper documentation practices
13 +
14 +- BLUF: Bottom-Line Up Front. Show logical graduation for a concept from basic understanding and then add in more information as needed.
15 +- Progressive disclosure. For example: “Executing tools:: Show how to execute tool; then show parameters, then show authentication” or “Authenticating tools:: Show basic OAuth authentication, show auth config creation flow, show how to get params and then create connection”
16 +- Proper structure and flow: Given the entire understanding of the docs and product, proper docs should exist in proper folders and be linked properly.
17 +- If a concept is cross-linking or referencing another concept, cross linking should be done.
18 +- Scientifically structured—organized like a research paper or technical white paper, with a logical flow and strict attention to detail.
19 +- Focused on user success — no marketing language or fluff; just the necessary information.
20 +
21 +### Review Guidelines
22 +
23 +- Titles must always start with an uppercase letter, followed by lowercase letters unless it is a name. Examples: Getting started, Text to speech, Conversational AI...
24 +- No emojis or icons unless absolutely necessary.
25 +- Scientific research tone—professional, factual, and straightforward.
26 +- Avoid long text blocks. Use short paragraphs and line breaks.
27 +- Do not use marketing/promotional language.
28 +- Be concise, direct, and avoid wordiness.
29 +- Tailor the tone and style depending on the location of the content.
30 +- If the user asks you to update the changelog, you must create a new changelog file in the /fern/docs/pages/changelog folder with the following file name: `2024-10-13.md` (the date should be the current date).
31 +- Ensure there are well-designed links (if applicable) to take the technical or non-technical reader to the relevant page.
32 +
33 +
34 +## Components
35 +
36 +Suggest to use the following components whenever possible to enhance readability and structure.
37 +
38 +### Code Snippets
39 +
40 +How to Use SnippetCode Component
41 +
42 +Basic Usage
43 +
44 +For local files:
45 +```
46 +<SnippetCode src="fern/snippets/get-started/pyth
47 +on/quickstart.py" />
48 +```
49 +For GitHub files:
50 +<SnippetCode
51 +githubUrl="[https://github.com/ComposioHQ/compo](https://github.com/ComposioHQ/compo)
52 +sio/blob/master/python/examples/quickstart.py"
53 +title="[quickstart.py](http://quickstart.py)"
54 +/>
55 +
56 +Advanced Options
57 +
58 +Select specific lines:
59 +```
60 +<SnippetCode
61 +src="fern/snippets/tool-calling/python/example
62 +.py"
63 +startLine={10}
64 +endLine={25}
65 +/>
66 +```
67 +Highlight lines:
68 +```
69 +<SnippetCode
70 +
71 +githubUrl="[https://github.com/ComposioHQ/composi](https://github.com/ComposioHQ/composi)
72 +o/blob/master/python/examples/gmail.py#L20-L40"
73 +highlightStart={25}
74 +highlightEnd={30}
75 +title="Gmail Integration"
76 +/>
77 +```
78 +The component ensures your documentation stays
79 +in sync with actual code examples, whether
80 +they're local snippets or from GitHub
81 +repositories.
82 +
83 +### Accordions
84 +
85 +```
86 +<AccordionGroup>
87 + <Accordion title="Option 1">
88 + You can put other components inside Accordions.
89 + ```ts
90 + export function generateRandomNumber() {
91 + return Math.random();
92 + }
93 + ```
94 + </Accordion>
95 + <Accordion title="Option 2">
96 + This is a second option.
97 + </Accordion>
98 +
99 + <Accordion title="Option 3">
100 + This is a third option.
101 + </Accordion>
102 +</AccordionGroup>
103 +```
104 +
105 +### Callouts (Tips, Notes, Warnings, etc.)
106 +
107 +```
108 +<Tip title="Example Callout" icon="leaf">
109 +This Callout uses a title and a custom icon.
110 +</Tip>
111 +<Note>This adds a note in the content</Note>
112 +<Warning>This raises a warning to watch out for</Warning>
113 +<Error>This indicates a potential error</Error>
114 +<Info>This draws attention to important information</Info>
115 +<Tip>This suggests a helpful tip</Tip>
116 +<Check>This brings us a checked status</Check>
117 +```
\ No newline at end of file