Skip to content

[AAASM-4837] 📝 (examples): Correct node examples' fictional real-provider-mode guidance #337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Chisanan232 merged 6 commits into from
Jul 18, 2026
Merged

[AAASM-4837] 📝 (examples): Correct node examples' fictional real-provider-mode guidance #337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b6dd0e1
📝 (examples): De-fictionalize langchain-js real-provider guidance
Chisanan232 Jul 18, 2026
e494ed9
📝 (examples): De-fictionalize openai-node real-provider guidance
Chisanan232 Jul 18, 2026
07824fb
📝 (examples): De-fictionalize langgraph-js env guidance
Chisanan232 Jul 18, 2026
60ddd8e
📝 (examples): De-fictionalize mastra env guidance
Chisanan232 Jul 18, 2026
89e0f22
📝 (examples): De-fictionalize vercel-ai env guidance
Chisanan232 Jul 18, 2026
7c617bc
📝 (examples): Fix custom-tool-policy dangling .env.example ref
Chisanan232 Jul 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions node/custom-tool-policy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,15 @@ No gateway or API key required. All tests run offline.
pnpm typecheck
```

## Note on `.env.example`

This example uses only mock/offline mode. No provider keys or gateway URL are needed. To connect to a real gateway, set `AAASM_GATEWAY_URL` in your environment directly.
## Offline-only demo (no real-provider mode)

This example runs **fully offline**. Tool calls are governed in-process by a
local fail-closed policy stub (`createPolicyGatewayClient` in `src/policy.ts`) —
no gateway, no API key, and no network are involved. The example reads **no**
environment variables: `AAASM_GATEWAY_URL`, `OPENAI_API_KEY`, and friends have
no effect here, so there is no "real-provider" mode to switch into. Wiring these
examples to a real gateway/LLM via the SDK's `initAssembly` is a possible future
enhancement, tracked separately — not current behavior.

## Troubleshooting

Expand Down
8 changes: 0 additions & 8 deletions node/langchain-js-basic-agent/.env.example
View file
Open in desktop

This file was deleted.

18 changes: 8 additions & 10 deletions node/langchain-js-basic-agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,23 +73,21 @@ Tests run in offline mode — no gateway or API keys required.
pnpm typecheck
```

## Real-provider mode (optional)
## Offline-only demo (no real-provider mode)

Copy `.env.example` to `.env` and fill in your values:

```bash
cp .env.example .env
# Edit .env: set AAASM_GATEWAY_URL and optionally OPENAI_API_KEY
```

Then `pnpm start` will connect to the real gateway and real OpenAI API if configured.
This example runs **fully offline**. Tool calls are governed in-process by a
local fail-closed policy stub (`createPolicyGatewayClient` in `src/policy.ts`) —
no gateway, no API key, and no network are involved. The example reads **no**
environment variables: `AAASM_GATEWAY_URL`, `OPENAI_API_KEY`, and friends have
no effect here, so there is no "real-provider" mode to switch into. Wiring these
examples to a real gateway/LLM via the SDK's `initAssembly` is a possible future
enhancement, tracked separately — not current behavior.

## Troubleshooting

| Problem | Solution |
|---------|----------|
| `Cannot find module '@agent-assembly/sdk'` | Run `pnpm install` |
| Gateway connection refused | Omit `AAASM_GATEWAY_URL` to use offline mode |
| TypeScript errors | Run `pnpm typecheck` and check Node.js version |

## Links
Expand Down
8 changes: 0 additions & 8 deletions node/langgraph-js/.env.example
View file
Open in desktop

This file was deleted.

13 changes: 9 additions & 4 deletions node/langgraph-js/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,15 @@ No gateway or API key required. All tests run offline.
pnpm typecheck
```

## Note on `.env.example`

This example uses only mock/offline mode. No provider keys or gateway URL are needed.
To connect to a real gateway, set `AAASM_GATEWAY_URL` in your environment directly.
## Offline-only demo (no real-provider mode)

This example runs **fully offline**. Tool calls are governed in-process by a
local fail-closed policy stub (`createPolicyGatewayClient` in `src/policy.ts`) —
no gateway, no API key, and no network are involved. The example reads **no**
environment variables: `AAASM_GATEWAY_URL`, `OPENAI_API_KEY`, and friends have
no effect here, so there is no "real-provider" mode to switch into. Wiring these
examples to a real gateway/LLM via the SDK's `initAssembly` is a possible future
enhancement, tracked separately — not current behavior.

## Troubleshooting

Expand Down
8 changes: 0 additions & 8 deletions node/mastra/.env.example
View file
Open in desktop

This file was deleted.

14 changes: 9 additions & 5 deletions node/mastra/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,15 @@ No gateway or API key required. All tests run offline.
pnpm typecheck
```

## Note on `.env.example`

This example uses only mock/offline mode. No provider keys or gateway URL are needed.
To connect to a real gateway, set `AAASM_GATEWAY_URL` in your environment directly; to
drive a real LLM with a Mastra Agent, set `OPENAI_API_KEY`.
## Offline-only demo (no real-provider mode)

This example runs **fully offline**. Tool calls are governed in-process by a
local fail-closed policy stub (`createPolicyGatewayClient` in `src/policy.ts`) —
no gateway, no API key, and no network are involved. The example reads **no**
environment variables: `AAASM_GATEWAY_URL`, `OPENAI_API_KEY`, and friends have
no effect here, so there is no "real-provider" mode to switch into. Wiring these
examples to a real gateway/LLM via the SDK's `initAssembly` is a possible future
enhancement, tracked separately — not current behavior.

## Troubleshooting

Expand Down
8 changes: 0 additions & 8 deletions node/openai-node-tool-policy/.env.example
View file
Open in desktop

This file was deleted.

16 changes: 8 additions & 8 deletions node/openai-node-tool-policy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,21 +76,21 @@ All tests run offline — no gateway or API key required.
pnpm typecheck
```

## Real-provider mode (optional)
## Offline-only demo (no real-provider mode)

Copy `.env.example` to `.env` and configure:

```bash
cp .env.example .env
# Set AAASM_GATEWAY_URL and optionally OPENAI_API_KEY
```
This example runs **fully offline**. Tool calls are governed in-process by a
local fail-closed policy stub (`createPolicyGatewayClient` in `src/policy.ts`) —
no gateway, no API key, and no network are involved. The example reads **no**
environment variables: `AAASM_GATEWAY_URL`, `OPENAI_API_KEY`, and friends have
no effect here, so there is no "real-provider" mode to switch into. Wiring these
examples to a real gateway/LLM via the SDK's `initAssembly` is a possible future
enhancement, tracked separately — not current behavior.

## Troubleshooting

| Problem | Solution |
|---------|----------|
| `Cannot find module '@agent-assembly/sdk'` | Run `pnpm install` |
| Gateway connection refused | Remove `AAASM_GATEWAY_URL` from `.env` to use offline mode |
| TypeScript errors | Run `pnpm typecheck` |

## Links
Expand Down
8 changes: 0 additions & 8 deletions node/vercel-ai/.env.example
View file
Open in desktop

This file was deleted.

14 changes: 9 additions & 5 deletions node/vercel-ai/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,15 @@ No gateway or API key required. All tests run offline.
pnpm typecheck
```

## Note on `.env.example`

This example uses only mock/offline mode. No provider keys or gateway URL are needed.
To connect to a real gateway, set `AAASM_GATEWAY_URL` in your environment directly; to
drive a real LLM, set `OPENAI_API_KEY`.
## Offline-only demo (no real-provider mode)

This example runs **fully offline**. Tool calls are governed in-process by a
local fail-closed policy stub (`createPolicyGatewayClient` in `src/policy.ts`) —
no gateway, no API key, and no network are involved. The example reads **no**
environment variables: `AAASM_GATEWAY_URL`, `OPENAI_API_KEY`, and friends have
no effect here, so there is no "real-provider" mode to switch into. Wiring these
examples to a real gateway/LLM via the SDK's `initAssembly` is a possible future
enhancement, tracked separately — not current behavior.

## Troubleshooting

Expand Down
Loading