Document AGENTUITY_CLOUD_BASE_URL and AGENTUITY_CLOUD_DOMAINS environment variables#356
Document AGENTUITY_CLOUD_BASE_URL and AGENTUITY_CLOUD_DOMAINS environment variables#356devin-ai-integration[bot] wants to merge 1 commit intomainfrom
Conversation
…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 EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
📝 WalkthroughWalkthroughAdds 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
🚥 Pre-merge checks | ✅ 1✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
There was a problem hiding this comment.
🧹 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
📒 Files selected for processing (3)
content/Get-Started/app-configuration.mdxcontent/Reference/CLI/deployment.mdxcontent/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 describesAGENTUITY_CLOUD_BASE_URLas the deployment URL andAGENTUITY_CLOUD_DOMAINSas 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_URLto the canonical deployment URL (not project URL)- Provides
AGENTUITY_CLOUD_DOMAINSas a comma-separated string
|
@parteeksingh24 — this PR is assigned to you for review per Rick's request. It documents the |
Summary
Documents the platform-injected environment variables available in cloud deployments, specifically
AGENTUITY_CLOUD_BASE_URLandAGENTUITY_CLOUD_DOMAINS(plusAGENTUITY_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:
Review & Testing Checklist for Human
AGENTUITY_CLOUD_BASE_URLdescription 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?AGENTUITY_CLOUD_DOMAINSformat: SDK source code (cors.ts,auth/config.ts) treats it as comma-separated, butenv.d.tscomment says "JSON array of domain strings". The docs say comma-separated — confirm this is correct.npm run dev).Notes
Summary by CodeRabbit