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

next
md 27 lines 1.68 KB
Rendered Raw
1 # SDK Reference Documentation
2
3 Auto-generated SDK documentation from source code.
4
5 ## TypeScript SDK
6
7 | Item | Path |
8 | ---------- | --------------------------------------------------- |
9 | Source | `ts/packages/core/src/models/*.ts` (JSDoc comments) |
10 | Generator | `ts/packages/core/scripts/generate-docs.ts` |
11 | Output | `content/reference/sdk-reference/typescript/` |
12 | Regenerate | `pnpm --filter @composio/core generate:docs` |
13
14 ## Python SDK
15
16 | Item | Path |
17 | ---------- | ----------------------------------------------------------------------------------------------------------- |
18 | Source | `python/composio/**/*.py` (docstrings) |
19 | Generator | `python/scripts/generate-docs.py` (griffe, pinned in the `docs-reference` group in `python/pyproject.toml`) |
20 | Output | `content/reference/sdk-reference/python/` |
21 | Regenerate | `cd python && uv run --frozen --only-group docs-reference python scripts/generate-docs.py` |
22
23 ## CI Integration
24
25 On PRs to `next` that change either SDK source or generator, `.github/workflows/docs-sdk-reference-drift.yml` regenerates both references and fails if the committed output differs. Regenerate with the commands above and commit the result.
26
27 The SDK release workflow (`.github/workflows/sdk.release.yml`) also regenerates both references in each release PR, so the published reference always matches the released packages.