feat: update SDK installation instructions and enhance development scripts#1779
feat: update SDK installation instructions and enhance development scripts#1779alt-glitch merged 1 commit intonextfrom
Conversation
alt-glitch
commented
Jul 22, 2025
alt-glitch
commented
- Changed the "dev" script to run build snippets before starting the documentation server.
- Added a new "dev:all" task in turbo.json for better dependency management.
- Updated installation commands in documentation to reflect the new version 0.8.0 for various Composio packages.
- Adjusted authentication snippets and examples for clarity and accuracy.
…ripts - Changed the "dev" script to run build snippets before starting the documentation server. - Added a new "dev:all" task in turbo.json for better dependency management. - Updated installation commands in documentation to reflect the new version 0.8.0 for various Composio packages. - Adjusted authentication snippets and examples for clarity and accuracy.
|
Claude finished @alt-glitch's task —— View job Documentation Review Complete ✅I've thoroughly reviewed the documentation changes in this PR focusing on grammar, spelling, clarity, readability, consistency, tone, and adherence to the style guide in Todo List:
🎯 Overall Assessment: EXCELLENTThis PR demonstrates strong attention to detail with consistent, professional documentation updates that significantly improve the developer experience. ✅ StrengthsVersion Consistency & Accuracy
Development Workflow Improvements
Documentation Quality
🔍 Detailed Review FindingsGrammar & Spelling✅ No issues found - All text is grammatically correct with proper spelling throughout. Clarity & Readability✅ Excellent clarity - Installation commands are clear and actionable. Code examples are well-structured with appropriate context. Consistency & Tone✅ Professional consistency - Maintains the scientific research tone specified in the style guide. No marketing fluff or unnecessary elaboration. Style Guide Adherence✅ Full compliance with
🚀 Impact AssessmentThis PR significantly improves:
💡 Minor Suggestions (Optional improvements for future consideration)
Verdict: This PR is ready for merge. The documentation changes are professional, consistent, and significantly improve the developer experience with accurate version information and better development workflows. |
![entelligence-ai-pr-reviews[bot]](https://avatars.githubusercontent.com/in/932812?s=60&v=4){kind=small}
| f"https://api.github.com/repos/composiohq/composio/issues/{request.issue_number}", | ||
| headers={ | ||
| "Accept": "application/vnd.github.v3+json", | ||
| "Authorization": f"Bearer {auth_credentials['access_token']}", |
There was a problem hiding this comment.
correctness: auth_credentials['access_token'] access will raise a KeyError if 'access_token' is missing, causing a runtime crash for incomplete credentials.
🤖 AI Agent Prompt for Cursor/Windsurf
📋 Copy this prompt to your AI coding assistant (Cursor, Windsurf, etc.) to get help fixing this issue
In fern/pages/src/tool-calling/custom-tools.mdx, on line 166, the code accesses `auth_credentials['access_token']` directly, which will raise a KeyError if 'access_token' is missing. Change this to use `auth_credentials.get('access_token', '')` to prevent runtime crashes when the key is absent.
📝 Committable Code Suggestion
‼️ Ensure you review the code suggestion before committing it to the branch. Make sure it replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| "Authorization": f"Bearer {auth_credentials['access_token']}", | |
| "Authorization": f"Bearer {auth_credentials.get('access_token', '')}", |
| ) -> dict: | ||
| """Get information about a GitHub issue.""" | ||
| response = requests.get( | ||
| f"https://api.github.com/repos/composiohq/composio/issues/{request.issue_number}", |
There was a problem hiding this comment.
security: request.issue_number is used directly in the GitHub API URL without validation, allowing path traversal or injection if attacker controls issue_number.
🤖 AI Agent Prompt for Cursor/Windsurf
📋 Copy this prompt to your AI coding assistant (Cursor, Windsurf, etc.) to get help fixing this issue
In fern/pages/src/tool-calling/custom-tools.mdx, lines 163-163, the code uses `request.issue_number` directly in the GitHub API URL, which could allow path traversal or injection if an attacker controls `issue_number`. Update the code to validate that `issue_number` is a digit before using it in the URL. Raise a ValueError if it is not valid. Apply the fix with correct indentation.
📝 Committable Code Suggestion
‼️ Ensure you review the code suggestion before committing it to the branch. Make sure it replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| f"https://api.github.com/repos/composiohq/composio/issues/{request.issue_number}", | |
| issue_number = str(request.issue_number) | |
| if not issue_number.isdigit(): | |
| raise ValueError("Invalid issue number") | |
| response = requests.get( | |
| f"https://api.github.com/repos/composiohq/composio/issues/{issue_number}", |
| user_id=user_id, | ||
| auth_config_id=airtable_auth_config_id, | ||
| config=auth_scheme.bearer_token() | ||
| config={"auth_scheme": "BEARER_TOKEN", "val": user_bearer_token}, |
There was a problem hiding this comment.
correctness: user_bearer_token is used in the config for Airtable but is never defined, causing a runtime NameError and breaking authentication.
🤖 AI Agent Prompt for Cursor/Windsurf
📋 Copy this prompt to your AI coding assistant (Cursor, Windsurf, etc.) to get help fixing this issue
In fern/snippets/tool-calling/python/auth-tools.py, line 45, the variable `user_bearer_token` is used but never defined, which will cause a NameError at runtime. Replace `user_bearer_token` with a valid bearer token string or ensure it is defined before this line.
📝 Committable Code Suggestion
‼️ Ensure you review the code suggestion before committing it to the branch. Make sure it replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| config={"auth_scheme": "BEARER_TOKEN", "val": user_bearer_token}, | |
| config={"auth_scheme": "BEARER_TOKEN", "val": "your_airtable_bearer_token_here"}, |
|
Preview your docs: https://composio-preview-a0b65d58-8e29-404c-83f8.docs.buildwithfern.com |
1 participant
