Skip to content

Document AGENTUITY_CLOUD_BASE_URL and AGENTUITY_CLOUD_DOMAINS environment variables#356

Open
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin/1772934888-add-cloud-env-vars-docs
Open

Document AGENTUITY_CLOUD_BASE_URL and AGENTUITY_CLOUD_DOMAINS environment variables#356
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin/1772934888-add-cloud-env-vars-docs

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Mar 8, 2026

Summary

Documents the platform-injected environment variables available in cloud deployments, specifically AGENTUITY_CLOUD_BASE_URL and AGENTUITY_CLOUD_DOMAINS (plus AGENTUITY_CLOUD_ORG_ID, AGENTUITY_CLOUD_PROJECT_ID, AGENTUITY_CLOUD_DEPLOYMENT_ID).

These were previously undocumented, causing confusion about how to discover a deployment's URL and associated domains at runtime.

Added to three docs pages for discoverability:

  • Get Started > App Configuration — new "Platform-Injected Environment Variables" subsection
  • Reference > SDK Reference — expanded the Environment Variables section
  • Reference > CLI > Deployment — new "Deployment Environment Variables" subsection under Deployment URLs

Review & Testing Checklist for Human

  • Verify AGENTUITY_CLOUD_BASE_URL description accuracy: The PR says it's the deployment URL (e.g. dep-abc123.agentuity.cloud). Confirm this matches what the platform actually injects — could it be the project URL instead?
  • Verify AGENTUITY_CLOUD_DOMAINS format: SDK source code (cors.ts, auth/config.ts) treats it as comma-separated, but env.d.ts comment says "JSON array of domain strings". The docs say comma-separated — confirm this is correct.
  • Verify the rendered pages look correct on the preview deployment or locally (npm run dev).

Notes

Summary by CodeRabbit

  • Documentation
    • Added documentation for platform-injected environment variables available in Agentuity Cloud deployments (AGENTUITY_CLOUD_BASE_URL, AGENTUITY_CLOUD_DOMAINS, AGENTUITY_CLOUD_ORG_ID, AGENTUITY_CLOUD_PROJECT_ID, AGENTUITY_CLOUD_DEPLOYMENT_ID).
    • Included code examples showing how to access these variables.
    • Clarified automatic CORS and authentication handling for cloud deployments.

…MAINS env vars

Document platform-injected environment variables available in cloud deployments:
- AGENTUITY_CLOUD_BASE_URL: canonical deployment URL
- AGENTUITY_CLOUD_DOMAINS: comma-separated list of all deployment domains
- AGENTUITY_CLOUD_ORG_ID, AGENTUITY_CLOUD_PROJECT_ID, AGENTUITY_CLOUD_DEPLOYMENT_ID

Updated in three places:
- Get Started > App Configuration
- Reference > SDK Reference
- Reference > CLI > Deployment

Co-Authored-By: Rick Blalock <rickblalock@mac.com>
@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 8, 2026

📝 Walkthrough

Walkthrough

Adds documentation for platform-injected environment variables provided by Agentuity Cloud, detailing AGENTUITY_CLOUD_BASE_URL, AGENTUITY_CLOUD_DOMAINS, and related variables across app configuration, CLI deployment, and SDK reference documentation.

Changes

Cohort / File(s) Summary
Platform-Injected Environment Variables
content/Get-Started/app-configuration.mdx, content/Reference/CLI/deployment.mdx, content/Reference/sdk-reference.mdx
Documents platform-injected environment variables provided by Agentuity Cloud, including AGENTUITY_CLOUD_BASE_URL, AGENTUITY_CLOUD_DOMAINS, AGENTUITY_CLOUD_ORG_ID, AGENTUITY_CLOUD_PROJECT_ID, and AGENTUITY_CLOUD_DEPLOYMENT_ID, with code examples, variable tables, and notes about automatic CORS and authentication handling.
🚥 Pre-merge checks | ✅ 1
✅ Passed checks (1 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
content/Reference/sdk-reference.mdx (1)

129-166: Consider extracting the cloud env-var block into a shared partial.

This table, example, and explanation now exist in three docs pages. Pulling them into a shared MDX partial/component would reduce drift the next time these runtime semantics change.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@content/Reference/sdk-reference.mdx` around lines 129 - 166, Extract the
repeated "Platform-Injected Environment Variables" table, example, and note into
a single shared MDX partial/component (e.g., CloudEnvVars) and replace the
duplicated block in sdk-reference.mdx and the other two docs with an import of
that partial; ensure the partial exports the table and example (including
references to AGENTUITY_CLOUD_BASE_URL, AGENTUITY_CLOUD_DOMAINS,
AGENTUITY_CLOUD_ORG_ID, AGENTUITY_CLOUD_PROJECT_ID,
AGENTUITY_CLOUD_DEPLOYMENT_ID and the example code using process.env) and update
each page to import and render the partial so future changes are made in one
place.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@content/Reference/sdk-reference.mdx`:
- Around line 129-166: Extract the repeated "Platform-Injected Environment
Variables" table, example, and note into a single shared MDX partial/component
(e.g., CloudEnvVars) and replace the duplicated block in sdk-reference.mdx and
the other two docs with an import of that partial; ensure the partial exports
the table and example (including references to AGENTUITY_CLOUD_BASE_URL,
AGENTUITY_CLOUD_DOMAINS, AGENTUITY_CLOUD_ORG_ID, AGENTUITY_CLOUD_PROJECT_ID,
AGENTUITY_CLOUD_DEPLOYMENT_ID and the example code using process.env) and update
each page to import and render the partial so future changes are made in one
place.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8cd37f6d-5a76-45d4-af8d-b290ff3c1186

📥 Commits

Reviewing files that changed from the base of the PR and between ae67c0e and 5ae70c6.

📒 Files selected for processing (3)
  • content/Get-Started/app-configuration.mdx
  • content/Reference/CLI/deployment.mdx
  • content/Reference/sdk-reference.mdx
📜 Review details
🔇 Additional comments (1)
content/Get-Started/app-configuration.mdx (1)

168-179: Check actual SDK/runtime implementation to validate documented env var semantics.

Documentation across three files (app-configuration.mdx, sdk-reference.mdx, CLI/deployment.mdx) consistently describes AGENTUITY_CLOUD_BASE_URL as the deployment URL and AGENTUITY_CLOUD_DOMAINS as comma-separated, with identical example code using .split(','). However, this docs repository contains no runtime or type definition files to validate these claims. Before publishing, confirm that the Agentuity runtime/SDK actually:

  • Sets AGENTUITY_CLOUD_BASE_URL to the canonical deployment URL (not project URL)
  • Provides AGENTUITY_CLOUD_DOMAINS as a comma-separated string

@devin-ai-integration
Copy link
Contributor Author

@parteeksingh24 — this PR is assigned to you for review per Rick's request. It documents the AGENTUITY_CLOUD_BASE_URL and AGENTUITY_CLOUD_DOMAINS platform-injected environment variables across three docs pages.

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.

0 participants