The best way to control Claude Code, Codex and more from any computer or phone
| 1 | import * as aiplatform from "@distilled.cloud/gcp/unstable/aiplatform_v1beta1"; |
| 2 | import { Unowned } from "alchemy/AdoptPolicy"; |
| 3 | import { isResolved } from "alchemy/Diff"; |
| 4 | import { createPhysicalName } from "alchemy/PhysicalName"; |
| 5 | import * as Provider from "alchemy/Provider"; |
| 6 | import { Resource } from "alchemy/Resource"; |
| 7 | import { tagRecord } from "alchemy/Tags"; |
| 8 | import * as Data from "effect/Data"; |
| 9 | import * as Effect from "effect/Effect"; |
| 10 | import * as Schedule from "effect/Schedule"; |
| 11 | import * as Stream from "effect/Stream"; |
| 12 | import { GcpEnvironment } from "../Environment.ts"; |
| 13 | import { createInternalLabels, diffLabels, hasAlchemyLabels, toLabels } from "../Labels.ts"; |
| 14 | import type { Providers } from "../Providers.ts"; |
| 15 | import { |
| 16 | encodeOwnership, |
| 17 | hasAlchemyLabelKeys, |
| 18 | hasOwnershipMarker, |
| 19 | normalizeLocation, |
| 20 | parentOf, |
| 21 | parseOwnership, |
| 22 | parseResourceName, |
| 23 | rfc1035, |
| 24 | resourceNameFromOperation, |
| 25 | stringMapOf, |
| 26 | userLabels, |
| 27 | waitForOperation, |
| 28 | } from "./internal.ts"; |
| 29 | |
| 30 | export type AgentTool = { |
| 31 | /** |
| 32 | * Tool type: `code_execution`, `filesystem`, `google_search`, |
| 33 | * `mcp_server`, or `url_context`. |
| 34 | */ |
| 35 | type?: string; |
| 36 | /** |
| 37 | * MCP server name. Only when `type` is `mcp_server`. |
| 38 | */ |
| 39 | name?: string; |
| 40 | /** |
| 41 | * MCP server endpoint URL. Only when `type` is `mcp_server`. |
| 42 | */ |
| 43 | url?: string; |
| 44 | /** |
| 45 | * MCP server headers (for example authentication). Only when `type` is |
| 46 | * `mcp_server`. |
| 47 | */ |
| 48 | headers?: Record<string, string>; |
| 49 | }; |
| 50 | |
| 51 | export type AgentProps = { |
| 52 | /** |
| 53 | * Agent id (the `{agent}` segment of |
| 54 | * `projects/{project}/locations/{location}/agents/{agent}`). If omitted, |
| 55 | * a unique name is generated. Must match |
| 56 | * `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. Immutable — changing it replaces |
| 57 | * the agent. |
| 58 | */ |
| 59 | agentId?: string; |
| 60 | /** |
| 61 | * Location. AgentService serves agents only in `global`. Immutable — |
| 62 | * changing it replaces the agent. |
| 63 | * @default "global" |
| 64 | */ |
| 65 | location?: string; |
| 66 | /** |
| 67 | * Base agent. Required by the API. |
| 68 | * @default "antigravity-preview-05-2026" |
| 69 | */ |
| 70 | baseAgent?: string; |
| 71 | /** |
| 72 | * Description. Alchemy also stamps ownership here when metadata is |
| 73 | * stripped by the API. |
| 74 | */ |
| 75 | description?: string; |
| 76 | /** |
| 77 | * System instruction passed to the LLM. |
| 78 | */ |
| 79 | systemInstruction?: string; |
| 80 | /** |
| 81 | * Tools available to the agent. |
| 82 | */ |
| 83 | tools?: AgentTool[]; |
| 84 | /** |
| 85 | * User metadata. Alchemy ownership labels are merged in automatically. |
| 86 | */ |
| 87 | metadata?: Record<string, string>; |
| 88 | /** |
| 89 | * Base environment (`remote`, an environment id, or a config struct). |
| 90 | */ |
| 91 | baseEnvironment?: unknown; |
| 92 | }; |
| 93 | |
| 94 | export type Agent = Resource< |
| 95 | "GCP.AIPlatform.Agent", |
| 96 | AgentProps, |
| 97 | { |
| 98 | /** Full resource name `projects/{project}/locations/{location}/agents/{agent}`. */ |
| 99 | name: string; |
| 100 | /** Agent id (last path segment). */ |
| 101 | agentId: string; |
| 102 | /** Project id. */ |
| 103 | project: string; |
| 104 | /** Location id. */ |
| 105 | location: string; |
| 106 | /** Base agent identifier. */ |
| 107 | baseAgent: string | undefined; |
| 108 | /** User description with the Alchemy ownership prefix stripped. */ |
| 109 | description: string | undefined; |
| 110 | /** System instruction. */ |
| 111 | systemInstruction: string | undefined; |
| 112 | /** Configured tools. */ |
| 113 | tools: AgentTool[]; |
| 114 | /** User metadata (Alchemy ownership keys stripped). */ |
| 115 | metadata: Record<string, string>; |
| 116 | /** Base environment. */ |
| 117 | baseEnvironment: unknown; |
| 118 | /** Object type (`agent`). */ |
| 119 | object: string | undefined; |
| 120 | /** RFC3339 creation timestamp. */ |
| 121 | created: string | undefined; |
| 122 | /** RFC3339 last-update timestamp. */ |
| 123 | updated: string | undefined; |
| 124 | }, |
| 125 | never, |
| 126 | Providers |
| 127 | >; |
| 128 | |
| 129 | /** |
| 130 | * A Vertex AI Agent — instructions and tool configuration for an LLM |
| 131 | * task. |
| 132 | * |
| 133 | * Agent id, location, and base agent are immutable. Description, system |
| 134 | * instruction, tools, and metadata update in place. Alchemy ownership is |
| 135 | * stored in `metadata` (and mirrored in `description`) so `list` / nuke |
| 136 | * can find the agent. |
| 137 | * |
| 138 | * ### Creating an Agent |
| 139 | * **Example:** Generated id |
| 140 | * ```typescript |
| 141 | * const agent = yield* GCP.AIPlatform.Agent("Support", { |
| 142 | * systemInstruction: "Answer product questions briefly.", |
| 143 | * metadata: { env: "test" }, |
| 144 | * }); |
| 145 | * ``` |
| 146 | * |
| 147 | * **Example:** Explicit id and a search tool |
| 148 | * ```typescript |
| 149 | * const agent = yield* GCP.AIPlatform.Agent("Research", { |
| 150 | * agentId: "research-bot", |
| 151 | * tools: [{ type: "google_search" }], |
| 152 | * }); |
| 153 | * ``` |
| 154 | * |
| 155 | * @resource |
| 156 | * @category AIPlatform |
| 157 | */ |
| 158 | export const Agent = Resource<Agent>("GCP.AIPlatform.Agent"); |
| 159 | |
| 160 | export class AgentNotResolved extends Data.TaggedError("GCP.AIPlatform.AgentNotResolved")<{ |
| 161 | resourceName: string; |
| 162 | }> {} |
| 163 | |
| 164 | export class AgentStillExists extends Data.TaggedError("GCP.AIPlatform.AgentStillExists")<{ |
| 165 | resourceName: string; |
| 166 | }> {} |
| 167 | |
| 168 | const DEFAULT_BASE_AGENT = "antigravity-preview-05-2026"; |
| 169 | |
| 170 | // AgentService answers 400 "AgentService not supported in this location" |
| 171 | // for regional locations such as us-central1. |
| 172 | const DEFAULT_LOCATION = "global"; |
| 173 | |
| 174 | const resourceName = (project: string, location: string, agentId: string) => |
| 175 | `projects/${project}/locations/${location}/agents/${agentId}`; |
| 176 | |
| 177 | const toId = (id: string, agentId: string | undefined, existing?: string) => |
| 178 | Effect.gen(function* () { |
| 179 | if (agentId !== undefined) return rfc1035(agentId); |
| 180 | if (existing !== undefined) return existing; |
| 181 | return rfc1035( |
| 182 | yield* createPhysicalName({ |
| 183 | id, |
| 184 | maxLength: 63, |
| 185 | lowercase: true, |
| 186 | }), |
| 187 | ); |
| 188 | }); |
| 189 | |
| 190 | const toolsOf = ( |
| 191 | tools: |
| 192 | | readonly AgentTool[] |
| 193 | | readonly aiplatform.GoogleCloudAiplatformV1beta1AgentTool[] |
| 194 | | undefined, |
| 195 | ): AgentTool[] => |
| 196 | (tools ?? []).map((tool) => ({ |
| 197 | type: tool.type, |
| 198 | name: tool.name, |
| 199 | url: tool.url, |
| 200 | headers: stringMapOf(tool.headers), |
| 201 | })); |
| 202 | |
| 203 | const toAttrs = (agent: aiplatform.GoogleCloudAiplatformV1beta1Agent, project: string) => { |
| 204 | const name = agent.name ?? ""; |
| 205 | const parsed = parseResourceName(name, "agents"); |
| 206 | const ownership = parseOwnership(agent.description); |
| 207 | return { |
| 208 | name, |
| 209 | agentId: agent.id ?? parsed.id, |
| 210 | project: parsed.project || project, |
| 211 | location: parsed.location, |
| 212 | baseAgent: agent.base_agent, |
| 213 | description: ownership.text, |
| 214 | systemInstruction: agent.system_instruction, |
| 215 | tools: toolsOf(agent.tools), |
| 216 | metadata: userLabels(agent.metadata), |
| 217 | baseEnvironment: agent.base_environment, |
| 218 | object: agent.object, |
| 219 | created: agent.created, |
| 220 | updated: agent.updated, |
| 221 | }; |
| 222 | }; |
| 223 | |
| 224 | // The v1 operations endpoint does not know AgentService operations. |
| 225 | const getOperation = (name: string) => aiplatform.getProjectsLocationsOperations({ name }); |
| 226 | |
| 227 | const getByName = (name: string) => |
| 228 | aiplatform |
| 229 | .getProjectsLocationsAgents({ name }) |
| 230 | .pipe(Effect.catchTag("NotFound", () => Effect.undefined)); |
| 231 | |
| 232 | const listAgents = (project: string, locations: readonly string[]) => { |
| 233 | const collect = (parent: string) => |
| 234 | aiplatform.listProjectsLocationsAgents.pages({ parent, pageSize: 100 }).pipe( |
| 235 | Stream.flatMap((page) => Stream.fromIterable(page.agents ?? [])), |
| 236 | Stream.runCollect, |
| 237 | Effect.map((chunk) => Array.from(chunk)), |
| 238 | ); |
| 239 | // Vertex AI has no `locations/-` wildcard; scan the known locations. |
| 240 | const scan = Effect.forEach([...new Set(locations)], (location) => |
| 241 | collect(`projects/${project}/locations/${location}`), |
| 242 | ).pipe(Effect.map((pages) => pages.flat())); |
| 243 | return scan.pipe(Effect.catchTag("NotFound", () => Effect.succeed([]))); |
| 244 | }; |
| 245 | |
| 246 | const isOwnedAgent = (agent: aiplatform.GoogleCloudAiplatformV1beta1Agent, id: string) => |
| 247 | Effect.gen(function* () { |
| 248 | if (yield* hasAlchemyLabels(id, tagRecord(agent.metadata))) return true; |
| 249 | const { labels } = parseOwnership(agent.description); |
| 250 | return yield* hasAlchemyLabels(id, labels); |
| 251 | }); |
| 252 | |
| 253 | const findOwned = (id: string, project: string, location: string, hinted?: string) => |
| 254 | Effect.gen(function* () { |
| 255 | if (hinted !== undefined && hinted.length > 0) { |
| 256 | const existing = yield* getByName(hinted); |
| 257 | if (existing !== undefined) return existing; |
| 258 | } |
| 259 | const agents = yield* listAgents(project, [DEFAULT_LOCATION, location]); |
| 260 | for (const agent of agents) { |
| 261 | if (yield* isOwnedAgent(agent, id)) return agent; |
| 262 | } |
| 263 | return undefined as aiplatform.GoogleCloudAiplatformV1beta1Agent | undefined; |
| 264 | }); |
| 265 | |
| 266 | const waitUntilExists = (name: string) => |
| 267 | getByName(name).pipe( |
| 268 | Effect.flatMap((agent) => |
| 269 | agent ? Effect.succeed(agent) : Effect.fail(new AgentNotResolved({ resourceName: name })), |
| 270 | ), |
| 271 | Effect.retry({ |
| 272 | while: (error) => error._tag === "GCP.AIPlatform.AgentNotResolved", |
| 273 | times: 8, |
| 274 | schedule: Schedule.spaced("1 second"), |
| 275 | }), |
| 276 | ); |
| 277 | |
| 278 | const waitUntilGone = (name: string) => |
| 279 | getByName(name).pipe( |
| 280 | Effect.flatMap((agent) => |
| 281 | agent === undefined ? Effect.void : Effect.fail(new AgentStillExists({ resourceName: name })), |
| 282 | ), |
| 283 | Effect.retry({ |
| 284 | while: (error) => error._tag === "GCP.AIPlatform.AgentStillExists", |
| 285 | times: 10, |
| 286 | schedule: Schedule.spaced("2 seconds"), |
| 287 | }), |
| 288 | ); |
| 289 | |
| 290 | export const AgentProvider = () => |
| 291 | Provider.succeed(Agent, { |
| 292 | stables: ["name", "agentId", "project", "location", "created"], |
| 293 | |
| 294 | diff: Effect.fn(function* ({ news, olds, output }) { |
| 295 | if (!isResolved(news)) return undefined; |
| 296 | const previousId = olds?.agentId ?? output?.agentId; |
| 297 | const nextId = news.agentId ?? previousId; |
| 298 | const previousLocation = normalizeLocation( |
| 299 | olds?.location ?? output?.location, |
| 300 | DEFAULT_LOCATION, |
| 301 | ); |
| 302 | const nextLocation = normalizeLocation( |
| 303 | news.location ?? olds?.location ?? output?.location, |
| 304 | DEFAULT_LOCATION, |
| 305 | ); |
| 306 | const previousBase = olds?.baseAgent ?? output?.baseAgent ?? DEFAULT_BASE_AGENT; |
| 307 | const nextBase = news.baseAgent ?? previousBase; |
| 308 | const replace = |
| 309 | (previousId !== undefined && nextId !== undefined && rfc1035(nextId) !== previousId) || |
| 310 | previousLocation !== nextLocation || |
| 311 | previousBase !== nextBase; |
| 312 | if (!replace) return undefined; |
| 313 | return { |
| 314 | action: "replace" as const, |
| 315 | deleteFirst: |
| 316 | previousLocation === nextLocation && |
| 317 | previousId !== undefined && |
| 318 | rfc1035(nextId ?? previousId) === previousId, |
| 319 | }; |
| 320 | }), |
| 321 | |
| 322 | read: Effect.fn(function* ({ id, olds, output }) { |
| 323 | const env = yield* GcpEnvironment.current; |
| 324 | const agentId = yield* toId(id, olds?.agentId, output?.agentId); |
| 325 | const location = normalizeLocation(olds?.location ?? output?.location, DEFAULT_LOCATION); |
| 326 | const name = output?.name ?? resourceName(env.project, location, agentId); |
| 327 | const existing = yield* findOwned(id, env.project, location, name); |
| 328 | if (existing === undefined) return undefined; |
| 329 | const attrs = toAttrs(existing, env.project); |
| 330 | return (yield* isOwnedAgent(existing, id)) ? attrs : Unowned(attrs); |
| 331 | }), |
| 332 | |
| 333 | list: () => |
| 334 | Effect.gen(function* () { |
| 335 | const env = yield* GcpEnvironment.current; |
| 336 | const agents = yield* listAgents(env.project, [DEFAULT_LOCATION]); |
| 337 | return agents |
| 338 | .filter( |
| 339 | (agent) => hasAlchemyLabelKeys(agent.metadata) || hasOwnershipMarker(agent.description), |
| 340 | ) |
| 341 | .map((agent) => toAttrs(agent, env.project)); |
| 342 | }), |
| 343 | |
| 344 | reconcile: Effect.fn(function* ({ id, news, output }) { |
| 345 | const env = yield* GcpEnvironment.current; |
| 346 | const location = normalizeLocation(news.location ?? output?.location, DEFAULT_LOCATION); |
| 347 | const agentId = yield* toId(id, news.agentId, output?.agentId); |
| 348 | const name = resourceName(env.project, location, agentId); |
| 349 | const internal = yield* createInternalLabels(id); |
| 350 | const desiredMetadata = { |
| 351 | ...toLabels(news.metadata), |
| 352 | ...internal, |
| 353 | }; |
| 354 | const desiredDescription = encodeOwnership(internal, news.description); |
| 355 | const baseAgent = news.baseAgent ?? DEFAULT_BASE_AGENT; |
| 356 | const tools = toolsOf(news.tools); |
| 357 | |
| 358 | let current = yield* findOwned(id, env.project, location, output?.name ?? name); |
| 359 | |
| 360 | if (current === undefined) { |
| 361 | const created = yield* aiplatform |
| 362 | .createProjectsLocationsAgents({ |
| 363 | parent: parentOf(env.project, location), |
| 364 | body: { |
| 365 | id: agentId, |
| 366 | base_agent: baseAgent, |
| 367 | description: desiredDescription, |
| 368 | system_instruction: news.systemInstruction, |
| 369 | tools, |
| 370 | metadata: desiredMetadata, |
| 371 | base_environment: news.baseEnvironment, |
| 372 | }, |
| 373 | }) |
| 374 | .pipe(Effect.catchTag("Conflict", () => Effect.undefined)); |
| 375 | if (created !== undefined) { |
| 376 | const done = yield* waitForOperation(created, { get: getOperation }); |
| 377 | const createdName = resourceNameFromOperation(done) ?? name; |
| 378 | current = yield* waitUntilExists(createdName); |
| 379 | } |
| 380 | if (current === undefined) { |
| 381 | current = yield* findOwned(id, env.project, location, name); |
| 382 | } |
| 383 | } |
| 384 | |
| 385 | if (current === undefined) { |
| 386 | return yield* new AgentNotResolved({ resourceName: name }); |
| 387 | } |
| 388 | |
| 389 | const currentName = current.name ?? name; |
| 390 | const observedMetadata = tagRecord(current.metadata); |
| 391 | const { upsert, removed } = diffLabels(observedMetadata, desiredMetadata); |
| 392 | const metadataChanged = upsert.length > 0 || removed.length > 0; |
| 393 | const descriptionChanged = (current.description ?? "") !== desiredDescription; |
| 394 | const instructionChanged = |
| 395 | (current.system_instruction ?? "") !== (news.systemInstruction ?? ""); |
| 396 | const toolsChanged = JSON.stringify(toolsOf(current.tools)) !== JSON.stringify(tools); |
| 397 | |
| 398 | if (metadataChanged || descriptionChanged || instructionChanged || toolsChanged) { |
| 399 | // Patch is a long-running operation; re-read the agent once it lands. |
| 400 | const patched = yield* aiplatform.patchProjectsLocationsAgents({ |
| 401 | name: currentName, |
| 402 | updateMask: [ |
| 403 | metadataChanged ? "metadata" : undefined, |
| 404 | descriptionChanged ? "description" : undefined, |
| 405 | instructionChanged ? "system_instruction" : undefined, |
| 406 | toolsChanged ? "tools" : undefined, |
| 407 | ] |
| 408 | .filter((field): field is string => field !== undefined) |
| 409 | .join(","), |
| 410 | body: { |
| 411 | name: currentName, |
| 412 | metadata: desiredMetadata, |
| 413 | description: desiredDescription, |
| 414 | system_instruction: news.systemInstruction, |
| 415 | tools, |
| 416 | }, |
| 417 | }); |
| 418 | yield* waitForOperation(patched, { get: getOperation }); |
| 419 | current = yield* waitUntilExists(currentName); |
| 420 | } |
| 421 | |
| 422 | return toAttrs(current, env.project); |
| 423 | }), |
| 424 | |
| 425 | delete: Effect.fn(function* ({ output }) { |
| 426 | const existing = yield* getByName(output.name); |
| 427 | if (existing === undefined) return; |
| 428 | const operation = yield* aiplatform |
| 429 | .deleteProjectsLocationsAgents({ name: output.name }) |
| 430 | .pipe(Effect.catchTag("NotFound", () => Effect.undefined)); |
| 431 | if (operation !== undefined) { |
| 432 | yield* waitForOperation(operation, { notFoundOk: true, get: getOperation }); |
| 433 | } |
| 434 | yield* waitUntilGone(output.name); |
| 435 | }), |
| 436 | }); |