Skip to content

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

updated prompts/claude.md for docs/sdk

[email protected]b9e129f463ff
diff --git a/.github/workflows/claude-code-doc-review.yml b/.github/workflows/claude-code-doc-review.yml
new file mode 100644
index 000000000..7ac4e66e7
--- /dev/null
+++ b/.github/workflows/claude-code-doc-review.yml
@@ -0,0 +1,70 @@
+name: Claude Code Review
+
+on:
+ pull_request:
+ types: [ opened, synchronize ]
+ # Optional: Only run on specific file changes
+ paths:
+ - "fern/pages/**/*.mdx"
+jobs:
+ claude-review:
+ # Optional: Filter by PR author
+ # if: |
+ # github.event.pull_request.user.login == 'external-contributor' ||
+ # github.event.pull_request.user.login == 'new-developer' ||
+ # github.event.pull_request.author_association == 'FIRST_TIME_CONTRIBUTOR'
+
+ runs-on: ubuntu-latest
+ permissions:
+ contents: read
+ pull-requests: read
+ issues: read
+ id-token: write
+
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v4
+ with:
+ fetch-depth: 1
+
+ - name: Run Claude Code Review
+ id: claude-review
+ uses: anthropics/claude-code-action@beta
+ with:
+ anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
+
+ # Optional: Specify model (defaults to Claude Sonnet 4, uncomment for Claude Opus 4)
+ # model: "claude-opus-4-20250514"
+
+ # Direct prompt for automated review (no @claude mention needed)
+ direct_prompt: |
+
+ Please review this pull request for documentation changes and provide feedback on:
+ - Grammar and spelling
+ - Clarity and readability
+ - Consistency and tone
+ - Proper adherence to the documentation style guide in `fern/CLAUDE.md`
+
+ Be constructive and helpful in your feedback.
+ # Optional: Customize review based on file types
+ # direct_prompt: |
+ # Review this PR focusing on:
+ # - For TypeScript files: Type safety and proper interface usage
+ # - For API endpoints: Security, input validation, and error handling
+ # - For React components: Performance, accessibility, and best practices
+ # - For tests: Coverage, edge cases, and test quality
+
+ # Optional: Different prompts for different authors
+ # direct_prompt: |
+ # ${{ github.event.pull_request.author_association == 'FIRST_TIME_CONTRIBUTOR' &&
+ # 'Welcome! Please review this PR from a first-time contributor. Be encouraging and provide detailed explanations for any suggestions.' ||
+ # 'Please provide a thorough code review focusing on our coding standards and best practices.' }}
+
+ # Optional: Add specific tools for running tests or linting
+ allowed_tools: "Bash(*)"
+
+ # Optional: Skip review for certain conditions
+ # if: |
+ # !contains(github.event.pull_request.title, '[skip-review]') &&
+ # !contains(github.event.pull_request.title, '[WIP]')
+
diff --git a/CLAUDE.md b/CLAUDE.md
index cc20a223d..ad1758df5 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -6,6 +6,10 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
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.
+## Memories and Notes
+
+- For documentation tasks, refer to `fern/CLAUDE.md`
+
## Common Development Commands
### Build and Development
@@ -205,4 +209,102 @@ const customTool = await composio.tools.createCustomTool({
});
```
-This monorepo uses pnpm workspaces and Turbo for efficient builds and development.
\ No newline at end of file
+This monorepo uses pnpm workspaces and Turbo for efficient builds and development.
+
+## Python SDK Development
+
+### Setup
+The Python SDK is located in the `/python/` directory and uses `uv` for dependency management and `nox` for automation.
+
+### Environment Setup
+```bash
+# Create and setup Python development environment
+cd python
+make env
+source .venv/bin/activate
+```
+
+### Python Development Commands
+```bash
+# Setup environment (creates virtual env with all dependencies)
+make env
+
+# Sync dependencies (when in an existing environment)
+make sync
+
+# Install provider packages
+make provider
+
+# Format code using ruff
+make fmt
+# Or directly: nox -s fmt
+
+# Check linting and type issues
+make chk
+# Or directly: nox -s chk
+
+# Fix linting issues
+nox -s fix
+
+# Run tests (requires implementing tst session)
+make tst
+# Or directly: nox -s tst
+
+# Run sanity tests (requires implementing snt session)
+make snt
+# Or directly: nox -s snt
+
+# Clean build artifacts
+make clean-build
+
+# Bump version
+make bump
+
+# Build packages
+make build
+```
+
+### Python Project Structure
+```
+python/
+├── composio/ # Main SDK package
+├── providers/ # Provider implementations
+├── tests/ # Test suite
+├── examples/ # Usage examples
+├── scripts/ # Development scripts
+├── config/ # Configuration files
+│ ├── pytest.ini # Pytest configuration
+│ ├── mypy.ini # MyPy type checking config
+│ ├── ruff.toml # Ruff linter/formatter config
+│ └── codecov.yml # Code coverage config
+├── Makefile # Development shortcuts
+├── noxfile.py # Nox automation sessions
+└── pyproject.toml # Project configuration
+```
+
+### Python Code Quality
+- **Formatter**: Ruff (Black-compatible, 88 char line length)
+- **Linter**: Ruff with custom configuration
+- **Type Checker**: mypy with strict optional typing
+- **Test Framework**: pytest with custom markers (core, openai, langchain, agno)
+- **Python Version**: >=3.10, <4
+- **Dependency Managers**: uv
+
+### Python Testing
+```bash
+# Run tests with pytest markers
+pytest -m core # Run core tests only
+pytest -m openai # Run OpenAI provider tests
+pytest -m langchain # Run LangChain provider tests
+pytest -m agno # Run Agno provider tests
+```
+
+### Python Package Dependencies
+- Core: `pysher`, `pydantic>=2.6.4`, `composio-client==1.4.0`, `typing-extensions>=4.0.0`, `openai`
+- Dev: `nox`, `pytest`, `ruff`, `langchain_openai`, `fastapi`, `twine`, `click`, `semver`
+
+### Python Environment Variables
+Same as TypeScript SDK, with additional:
+```bash
+OPENAI_API_KEY # Required for OpenAI provider examples
+```
\ No newline at end of file
diff --git a/fern/CLAUDE.md b/fern/CLAUDE.md
index e69de29bb..fcd84fe7e 100644
--- a/fern/CLAUDE.md
+++ b/fern/CLAUDE.md
@@ -0,0 +1,117 @@
+# CLAUDE.md
+
+You are reviewing technical documentation for the Composio SDK and API.
+
+Your task is to:
+- Catch and fix any and all grammar and spelling mistakes.
+- Find logical gaps in explanations that might make it difficult to understand a concept for a user.
+- Find and suggest fixes in ``` codeblocks when proper practices aren’t being followed.
+
+Read through the previous docs in `fern/pages/src` to understand how they are written.
+
+### Proper documentation practices
+
+- BLUF: Bottom-Line Up Front. Show logical graduation for a concept from basic understanding and then add in more information as needed.
+- 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”
+- Proper structure and flow: Given the entire understanding of the docs and product, proper docs should exist in proper folders and be linked properly.
+- If a concept is cross-linking or referencing another concept, cross linking should be done.
+- Scientifically structured—organized like a research paper or technical white paper, with a logical flow and strict attention to detail.
+- Focused on user success — no marketing language or fluff; just the necessary information.
+
+### Review Guidelines
+
+- 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...
+- No emojis or icons unless absolutely necessary.
+- Scientific research tone—professional, factual, and straightforward.
+- Avoid long text blocks. Use short paragraphs and line breaks.
+- Do not use marketing/promotional language.
+- Be concise, direct, and avoid wordiness.
+- Tailor the tone and style depending on the location of the content.
+- 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).
+- Ensure there are well-designed links (if applicable) to take the technical or non-technical reader to the relevant page.
+
+
+## Components
+
+Suggest to use the following components whenever possible to enhance readability and structure.
+
+### Code Snippets
+
+How to Use SnippetCode Component
+
+Basic Usage
+
+For local files:
+```
+<SnippetCode src="fern/snippets/get-started/pyth
+on/quickstart.py" />
+```
+For GitHub files:
+<SnippetCode
+githubUrl="[https://github.com/ComposioHQ/compo](https://github.com/ComposioHQ/compo)
+sio/blob/master/python/examples/quickstart.py"
+title="[quickstart.py](http://quickstart.py)"
+/>
+
+Advanced Options
+
+Select specific lines:
+```
+<SnippetCode
+src="fern/snippets/tool-calling/python/example
+.py"
+startLine={10}
+endLine={25}
+/>
+```
+Highlight lines:
+```
+<SnippetCode
+
+githubUrl="[https://github.com/ComposioHQ/composi](https://github.com/ComposioHQ/composi)
+o/blob/master/python/examples/gmail.py#L20-L40"
+highlightStart={25}
+highlightEnd={30}
+title="Gmail Integration"
+/>
+```
+The component ensures your documentation stays
+in sync with actual code examples, whether
+they're local snippets or from GitHub
+repositories.
+
+### Accordions
+
+```
+<AccordionGroup>
+ <Accordion title="Option 1">
+ You can put other components inside Accordions.
+ ```ts
+ export function generateRandomNumber() {
+ return Math.random();
+ }
+ ```
+ </Accordion>
+ <Accordion title="Option 2">
+ This is a second option.
+ </Accordion>
+
+ <Accordion title="Option 3">
+ This is a third option.
+ </Accordion>
+</AccordionGroup>
+```
+
+### Callouts (Tips, Notes, Warnings, etc.)
+
+```
+<Tip title="Example Callout" icon="leaf">
+This Callout uses a title and a custom icon.
+</Tip>
+<Note>This adds a note in the content</Note>
+<Warning>This raises a warning to watch out for</Warning>
+<Error>This indicates a potential error</Error>
+<Info>This draws attention to important information</Info>
+<Tip>This suggests a helpful tip</Tip>
+<Check>This brings us a checked status</Check>
+```
\ No newline at end of file