docs(integrations): project id optional everywhere; package overview README - #2777
Merged
Conversation
|
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
3 issues found and verified against the latest diff
Confidence score: 4/5
packages/integrations/README.mddoes not establishcoreas the contract source of truth, leaving the Deep Agents Python schemas and CrewAI instructions vulnerable to drift—define the contract in TypeScript and centralize or generate these representations.packages/integrations/README.mdlists anfx/integration that is absent from the checkout, which could mislead users about available projects—remove the row or add the missing integration before publishing.packages/integrations/README.mdinaccurately summarizes Python setup as resolving the publishedstagehandpackage, despite CrewAI using its own dependencies and the built Node facade—document the Deep Agents and CrewAI setup paths separately.
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="packages/integrations/README.md">
<violation number="1" location="packages/integrations/README.md:6">
P2: The contract is not defined once in `core`: the Deep Agents Python server redefines the tool schemas and descriptions, and CrewAI hard-codes the agent instructions. Qualify this as a TypeScript source of truth or centralize the cross-language contract; otherwise this overview promises synchronization that the code does not provide.</violation>
<violation number="2" location="packages/integrations/README.md:19">
P2: The overview documents an `fx/` integration that is not present in this checkout. Remove this row until the integration exists, or add the missing project before publishing the overview.</violation>
<violation number="3" location="packages/integrations/README.md:26">
P2: The setup summary says all Python projects resolve the published `stagehand` package, but CrewAI installs CrewAI dependencies and invokes the built Node facade. Distinguish Deep Agents' published Python SDK dependency from CrewAI's Node/MCP dependency so users do not look for a nonexistent Python package requirement.</violation>
</file>
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
Contributor
There was a problem hiding this comment.
3 issues found across 7 files
Confidence score: 5/5
packages/integrations/README.mdmisstates package resolution by grouping CrewAI with Python projects that resolvestagehand, which could mislead integration setup; clarify that Deep Agents uses the published Python package while CrewAI launches the Node facade fromcore/.packages/integrations/README.mdoverstates the shared contract by saying it is imported everywhere, while Python integrations duplicate the schema and agent prompt; qualify the guarantee as TypeScript-only or document the Python implementation.packages/integrations/README.mdlists a nonexistentfx/directory, leaving readers unable to locate the referenced templates or skill; remove the row or add the missing integration before publishing.
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="packages/integrations/README.md">
<violation number="1" location="packages/integrations/README.md:7">
P2: The overview says the contract is imported everywhere and never restated, but the Python integrations duplicate the schema and agent prompt. Qualify this as a TypeScript-only guarantee or document the Python implementations as separate mirrors.</violation>
<violation number="2" location="packages/integrations/README.md:19">
P2: The structure table lists `fx/`, but no `packages/integrations/fx/` directory exists, so readers cannot follow this entry to the claimed templates or skill. Remove the row or add the missing integration before publishing the overview.</violation>
<violation number="3" location="packages/integrations/README.md:26">
P2: The package-resolution summary incorrectly includes CrewAI among Python projects that resolve `stagehand`. State that Deep Agents uses the published Python package, while CrewAI launches the Node facade from `core/`.</violation>
</file>
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
Contributor
There was a problem hiding this comment.
All reported issues were addressed across 8 files
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
miguelg719
force-pushed
the
miguel/integrations-readme
branch
3 times, most recently
from
August 20, 2026 18:13
12a1549 to
7407463
Compare
…README BROWSERBASE_PROJECT_ID is optional now (API key is the only required Browserbase credential) — env tables and setup blocks updated across the example READMEs. The package README gains a structure overview with a one-line description per subdirectory.
miguelg719
force-pushed
the
miguel/integrations-readme
branch
from
August 20, 2026 18:19
7407463 to
3e7c0c5
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
BROWSERBASE_PROJECT_IDoptional in every example README (env tables + setup exports) — only the API key is required nowpackages/integrations/README.mdwith a structure overview and a one-liner per subdirectory (it previously described only the code-mode scaffold and deepagents)Why
The SDK patch made the project ID optional; the READMEs implied it was required in three examples and the package README predated the facade work entirely.
Testing
pnpm run fmt:checkclean; docs-only changeSummary by cubic
Removes
BROWSERBASE_PROJECT_IDfrom all integration READMEs and expands the integrations package overview so docs match the SDK: onlyBROWSERBASE_API_KEYis required. Runtime behavior is unchanged.claude-code,codex(simplify table),crewai,eve,mastra,pi, andvercel-ai; show only the API key.packages/integrations/README.mdwith a structure overview of the facade tools (run,snapshot,screenshot), the single contract incore/published as@browserbasehq/stagehand-integrations, a per-directory table (addsfx/, fixes Pi casing), and TS vs Python consumption notes.BROWSERBASE_PROJECT_IDfrom local envs if present.Written for commit 3e7c0c5. Summary will update on new commits.