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.

fix(docs): stabilize SDK reference auto PR checks

jkomyno0720b760e2a8
diff --git a/.github/workflows/claude-code-doc-review.yml b/.github/workflows/claude-code-doc-review.yml
index a23a7c46d..0d05084e9 100644
--- a/.github/workflows/claude-code-doc-review.yml
+++ b/.github/workflows/claude-code-doc-review.yml
@@ -36,7 +36,7 @@ jobs:
with:
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
track_progress: true # Forces tag mode with tracking comments
- allowed_bots: "devin-ai-integration[bot],decimal-pr-bot[bot],github-actions[bot],dependabot[bot],zen-agent"
+ allowed_bots: "devin-ai-integration[bot],decimal-pr-bot[bot],github-actions[bot],dependabot[bot],zen-agent,sdkrelease,sdkrelease[bot]"
# Optional: Specify model (defaults to Claude Sonnet 4, uncomment for Claude Opus 4)
# model: "claude-opus-4-20250514"
@@ -72,4 +72,3 @@ jobs:
# if: |
# !contains(github.event.pull_request.title, '[skip-review]') &&
# !contains(github.event.pull_request.title, '[WIP]')
-
diff --git a/.github/workflows/generate-sdk-docs.yml b/.github/workflows/generate-sdk-docs.yml
index 5ae22b7fe..653f586fd 100644
--- a/.github/workflows/generate-sdk-docs.yml
+++ b/.github/workflows/generate-sdk-docs.yml
@@ -5,7 +5,9 @@ on:
branches: [next]
paths:
- 'ts/packages/core/src/**'
+ - 'ts/packages/core/scripts/generate-docs.ts'
- 'python/composio/**'
+ - 'python/scripts/generate-docs.py'
- '.github/actions/setup-node-pnpm-bun/action.yml'
- '.github/actions/setup-python-uv/action.yml'
- '.github/workflows/generate-sdk-docs.yml'
diff --git a/python/scripts/generate-docs.py b/python/scripts/generate-docs.py
index b905f3d8c..7f41a9797 100644
--- a/python/scripts/generate-docs.py
+++ b/python/scripts/generate-docs.py
@@ -79,9 +79,7 @@ def to_kebab_case(name: str) -> str:
def escape_yaml_string(s: str) -> str:
"""Escape a string for YAML frontmatter."""
- if any(c in s for c in [":", '"', "'", "\n", "#", "{", "}"]):
- return f'"{s.replace(chr(34), chr(92) + chr(34))}"'
- return s
+ return json.dumps(s)
def get_source_link(obj: griffe.Object) -> str | None:
@@ -266,7 +264,7 @@ def generate_class_mdx(
desc = desc[:147] + "..."
lines.append("---")
- lines.append(f"title: {info['name']}")
+ lines.append(f"title: {escape_yaml_string(info['name'])}")
lines.append(f"description: {escape_yaml_string(desc)}")
lines.append("---")
lines.append("")
@@ -432,8 +430,8 @@ def generate_index_mdx(classes: list[dict], decorators: list[dict]) -> str:
dec_section = "\n".join(dec_lines)
return f"""---
-title: Python SDK Reference
-description: API reference for the Composio Python SDK
+title: {escape_yaml_string("Python SDK Reference")}
+description: {escape_yaml_string("API reference for the Composio Python SDK")}
---
# Python SDK Reference
diff --git a/ts/packages/core/scripts/generate-docs.ts b/ts/packages/core/scripts/generate-docs.ts
index 0c7e28c27..ef3995aab 100644
--- a/ts/packages/core/scripts/generate-docs.ts
+++ b/ts/packages/core/scripts/generate-docs.ts
@@ -243,6 +243,10 @@ function extractTag(comment: TypeDocReflection['comment'] | undefined, tagName:
return comment.blockTags.filter(t => t.tag === tagName).map(t => extractText(t.content));
}
+function formatYamlFrontmatterString(value: string): string {
+ return JSON.stringify(value);
+}
+
function formatType(type?: TypeDocType, depth = 0): string {
if (!type) return 'unknown';
if (depth > 5) return '...'; // Prevent infinite recursion
@@ -524,8 +528,8 @@ function generateClassMdx(classDoc: ClassDoc): string {
// Frontmatter - fumadocs renders title and description automatically
lines.push('---');
- lines.push(`title: ${classDoc.name}`);
- lines.push(`description: ${fullDescription}`);
+ lines.push(`title: ${formatYamlFrontmatterString(classDoc.name)}`);
+ lines.push(`description: ${formatYamlFrontmatterString(fullDescription)}`);
lines.push('---');
lines.push('');
@@ -807,8 +811,8 @@ async function main() {
.join('\n');
const indexContent = `---
-title: TypeScript SDK Reference
-description: Complete API reference for the Composio TypeScript SDK (@composio/core).
+title: ${formatYamlFrontmatterString('TypeScript SDK Reference')}
+description: ${formatYamlFrontmatterString('Complete API reference for the Composio TypeScript SDK (@composio/core).')}
---
## Installation