Skip to content

docs(integrations): rewrite codemode integration guides - #2685

Open
shrey150 wants to merge 2 commits into
mainfrom
agent/fix-integrations-lockfile
Open

docs(integrations): rewrite codemode integration guides#2685
shrey150 wants to merge 2 commits into
mainfrom
agent/fix-integrations-lockfile

Conversation

@shrey150

@shrey150 shrey150 commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Summary

  • replace the stale integration overview with a practical guide to the shared run, snapshot, and screenshot Code Mode tools
  • add runnable quickstarts for CrewAI, Deep Agents, Eve, Mastra, and the Vercel AI SDK
  • document framework-specific configuration, persistent browser-session requirements, screenshot behavior, and the browser security boundary
  • clarify that MCP child processes require an explicit STAGEHAND_MODEL_API_KEY, while the in-process Eve integration can infer supported provider credentials

Why

The integrations under packages/integrations had landed, but their READMEs still described earlier scaffolding and internal facade terminology. Developers needed one consistent path for choosing an adapter, building it from source, configuring the agent and browser models separately, and understanding the session/security constraints.

Impact

Developers can now follow framework-specific commands and use one documented tool contract across all five integrations. The guides make credential ownership explicit: agent-model keys stay in the host process, and MCP children receive only Stagehand and Browserbase configuration.

E2E Test Matrix

Command / flow Observed output Confidence / sufficiency
Fresh clone, corepack pnpm@11.10.0 install, and filtered integration build Install completed with pnpm 11.10.0; Turbo reported 4/4 build tasks successful. Proves the documented monorepo setup from a fresh checkout.
turbo run typecheck test:unit --filter @browserbasehq/stagehand-integrations 6/6 tasks passed; 18/18 core tests passed. Covers the shared tool contract, stdio lifecycle, server behavior, and TypeScript types.
CrewAI locked sync and contract tests Locked sync completed under Python 3.11; 3/3 tests passed. Verifies the documented Python environment and MCP adapter contract. The exact agent CLI reached the real model call but the configured provider account returned exhausted quota before a tool call.
Deep Agents locked sync + real Browserbase agent Both locked sync commands completed; after selecting an available provider through the documented model-edit step, the real agent initialized Stagehand, browsed public pages, and returned structured results. Proves the local Deep Agents model loop and Browserbase tool path. The checked-in OpenAI default was blocked by exhausted provider quota.
Eve dev, tests, and typecheck Eve v0.29.4 built and reached Ready; 5/5 tests and TypeScript passed. Proves the documented startup and native contract. The supplemental interactive task was blocked at the model call by exhausted provider quota before creating a browser.
Mastra MCP client + real Browserbase run Tool discovery succeeded; navigation to a public synthetic page returned Example Domain; the client disconnected and the browser completed. Proves Mastra transport, browser launch, tool execution, and cleanup. The exact model-driven CLI was blocked before tool use by exhausted provider quota.
Vercel AI SDK MCP client + real Browserbase run Tool discovery succeeded; navigation to a public synthetic page returned Example Domain; the client closed and the browser completed. Proves AI SDK transport, browser launch, tool execution, and cleanup. The exact model-driven CLI was blocked before tool use by exhausted provider quota.
Framework unit/typecheck matrix Deep Agents 7/7, Eve 5/5, Mastra 2/2, and Vercel AI SDK 2/2 tests passed; all TypeScript checks passed. Provides regression coverage for every documented adapter.

The previously included lockfile repair was removed because #2684 already merged that fix into main.

@changeset-bot

changeset-bot Bot commented Aug 10, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 5d5be70

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@shrey150
shrey150 marked this pull request as ready for review August 10, 2026 16:48

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 2 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.
Architecture diagram
sequenceDiagram
    participant CI as CI Pipeline
    participant Pnpm as pnpm 11.10.0
    participant Catalog as pnpm Catalog
    participant EvePkg as Eve Package (packages/integrations/eve)
    participant Lockfile as pnpm-lock.yaml
    participant TypeCheck as turbo typecheck

    Note over CI,TypeCheck: Workspace lockfile repair flow

    CI->>Pnpm: corepack pnpm@11.10.0 install --frozen-lockfile
    Pnpm->>Catalog: read catalog entries from pnpm-workspace.yaml
    Catalog-->>Pnpm: catalog includes eve: 0.29.4
    Pnpm->>EvePkg: resolve eve dependency from catalog
    EvePkg-->>Pnpm: package.json references eve: catalog:
    Pnpm->>Lockfile: verify lockfile matches catalog + dependencies
    alt Lockfile valid and complete
        Lockfile-->>Pnpm: supply-chain policy OK, "Already up to date"
        Pnpm-->>CI: install success
    end

    CI->>TypeCheck: turbo run typecheck --filter='./packages/integrations/*'
    TypeCheck->>EvePkg: typecheck Eve workspace
    EvePkg-->>TypeCheck: TypeScript exit code 0
    TypeCheck-->>CI: 7/7 tasks passed

    Note over Pnpm,Lockfile: Lockfile includes Eve importer and transitive snapshots
    Pnpm->>Lockfile: regenerate with pnpm 11.10.0
    Lockfile-->>Pnpm: complete dependency graph for Eve
Loading

Re-trigger cubic

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 6 files (changes from recent commits).

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread packages/integrations/README.md Outdated
Comment thread packages/integrations/crewai/README.md Outdated
Comment thread packages/integrations/eve/README.md Outdated
Comment thread packages/integrations/mastra/README.md Outdated
## Summary

- replace the stale package overview with a practical guide to the three
codemode browser tools
- add a framework-selection table, build instructions, shared
configuration, tool examples, and the security boundary
- rewrite the CrewAI, Deep Agents, Eve, Mastra, and Vercel AI SDK guides
around runnable quickstarts
- remove the internal “facade” framing from all integration READMEs
- correct stale Deep Agents configuration guidance: the local example's
model and task are source-defined in `agent.py`

## Impact

Developers can now choose an integration, understand MCP versus native
transport, copy an exact setup flow, and see the session/security
limitations before running agent-authored browser code.

## Verification

| Command / flow | Observed output | Confidence / sufficiency |
| --- | --- | --- |
| `oxfmt --check <six integration READMEs>` | All six files matched
repository formatting. | Proves Markdown formatting is consistent with
the repo toolchain. |
| Core `typecheck test:unit` through Turbo | 18/18 tests passed; all
dependency-aware tasks passed. | Covers the shared codemode contract,
stdio lifecycle, server schema, and TypeScript types. |
| Eve `test` + `typecheck` | 5/5 tests passed; TypeScript passed. |
Verifies the README's native-integration commands. |
| Mastra `test` + `typecheck` | 2/2 tests passed; TypeScript passed. |
Verifies the README's MCP client commands. |
| Vercel AI SDK `test` + `typecheck` | 2/2 tests passed; TypeScript
passed. | Verifies the README's MCP client commands. |
| CrewAI `uv run --locked pytest -q` | 3/3 tests passed. | Verifies the
documented Python environment and MCP contract. |
| Deep Agents `uv run --locked pytest -q` | 7/7 tests passed. | Verifies
the documented Python environment and server contract. |

Live-browser smoke results and any code fixes will follow in the next
stacked PR.

<!-- This is an auto-generated description by cubic. -->
---
## Summary by cubic
Rewrote and refreshed the codemode integration guides with runnable
quickstarts, a consistent `run`/`snapshot`/`screenshot` tool contract,
and clear security boundaries across CrewAI, Deep Agents (local +
managed), Eve, Mastra, and Vercel AI SDK. Also updated the Vercel AI
guide to point readers to the Eve native integration when appropriate.

- New Features
- Unified quickstarts with exact build/run steps and prerequisites;
build `@browserbasehq/stagehand-integrations` from source and run
examples directly.
- Root guide adds a choose-your-framework table, persistent browser and
snapshot-ID rules, and supported snapshot actions.
- Per-framework env config and verification commands; host model creds
stay in the host, while MCP children only receive
`STAGEHAND_*`/`BROWSERBASE_*`.
- Documented Browserbase as the isolation boundary and added session
lifecycle notes (Eve persistence, Deep Agents managed/runtime details).
- Vercel AI README now includes a note directing users to the Eve
integration for native in-process tools.

- Bug Fixes
- Deep Agents: corrected local example config; the model, task, and
optional schema live in `agent.py` (not CLI flags).

<sup>Written for commit b49e310.
Summary will update on new commits.</sup>

<a
href="https://cubic.dev/pr/browserbase/stagehand/pull/2686?utm_source=github"
target="_blank" rel="noopener noreferrer"
data-no-image-dialog="true"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"><source
media="(prefers-color-scheme: light)"
srcset="https://www.cubic.dev/buttons/review-in-cubic-light.svg"><img
alt="Review in cubic"
src="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"></picture></a>

<!-- End of auto-generated description by cubic. -->
@shrey150
shrey150 force-pushed the agent/fix-integrations-lockfile branch from 5458a0d to 5d5be70 Compare August 12, 2026 23:14
@shrey150 shrey150 changed the title fix(integrations): repair pnpm workspace lockfile docs(integrations): rewrite codemode integration guides Aug 12, 2026

@Kylejeong2 Kylejeong2 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, other than the project id stuff

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants