claude-code-system-prompts/system-prompts/data-managed-agents-environments-and-resources.md
2026-04-08 18:20:57 -06:00

8.6 KiB
Raw Blame History

Managed Agents — Environments & Resources

Environments

Creating a session requires an environment_id. Environments are reusable configuration templates for spinning up containers in Anthropic's infrastructure — you might create different environments for different use cases (e.g. data visualization vs web development, with different package sets). Anthropic handles scaling, container lifecycle, and work orchestration.

Environment names must be unique. Creating an environment with an existing name returns 409.

Networking

Network Policy Description
unrestricted Full egress (except legal blocklist)
package_managers_and_custom Package managers + custom allowed_hosts
{
  "networking": {
    "type": "package_managers_and_custom",
    "allowed_hosts": ["api.example.com"]
  }
}

MCP caveat: If using restricted networking, make sure allowed_hosts includes your MCP server domains. Otherwise the container can't reach them and tools silently fail.

Creating an environment

The SDK adds managed-agents-2026-04-01 automatically. TypeScript:

const env = await client.beta.environments.create({
  name: "my_env",
  config: {
    type: "cloud",
    networking: { type: "unrestricted" },
  },
});

Environment CRUD

Operation Method Path Notes
Create POST /v1/environments
List GET /v1/environments Paginated (limit, after_id, before_id)
Get GET /v1/environments/{id}
Update POST /v1/environments/{id} Changes apply only to new containers; existing sessions keep their original config
Delete DELETE /v1/environments/{id} Returns 204.
Archive POST /v1/environments/{id}/archive Read-only. New sessions can't be created; existing ones continue.

Resources

Attach files and GitHub repositories to a session. Session creation blocks until all resources are mounted — the container won't go running until every file and repo is in place. Max 999 file resources per session. Multiple GitHub repositories per session are supported.

File Uploads (input — host → agent)

Upload a file first via the Files API, then reference by file_id + mount_path:

// 1. Upload
const file = await client.beta.files.upload({
  file: fs.createReadStream("data.csv"),
  purpose: "agent",
});

// 2. Attach as a session resource
const session = await client.beta.sessions.create({
  agent: agent.id,
  environment_id: envId,
  resources: [
    { type: "file", file_id: file.id, mount_path: "/workspace/data.csv" }
  ],
});

mount_path is required and must be absolute. Parent directories are created automatically. Agent working directory defaults to /workspace. Files are mounted read-only — the agent writes modified versions to new paths.

Session outputs (output — agent → host)

The agent can write files to /mnt/session/outputs/ during a session. These are automatically captured by the Files API and can be listed and downloaded afterwards:

// After the turn completes, list output files scoped to this session:
for await (const f of client.beta.files.list({ scope: session.id })) {
  console.log(f.filename, f.size_bytes);
  const resp = await client.beta.files.download(f.id);
  const text = await resp.text();
}

Requirements:

  • The write tool (or bash) must be enabled for the agent to create output files.
  • Session-scoped files.list / files.download captures outputs written to /mnt/session/outputs/.
  • session_id is a query filter on files.list (not yet in SDK types — cast or spread through).
  • There's a brief indexing lag (~13s) between session.status_idle and output files appearing in files.list. Retry once or twice if empty.

This gives you a bidirectional file bridge: upload reference data in, download agent artifacts out.

GitHub Repositories

Clones a GitHub repository into the session container during initialization, before the agent begins execution. The agent can read, edit, commit, and push via bash (git). Multiple repositories per session are supported — add one resources entry per repo.

Fields:

Field Required Notes
type "github_repository"
url The GitHub repository URL
authorization_token GitHub Personal Access Token with repository access. Never echoed in API responses.
mount_path Path where the repository will be cloned. Defaults to /workspace/<repo-name>.
checkout {type: "branch", name: "..."} or {type: "commit", sha: "..."}. Defaults to the repo's default branch.

Token permission levels (fine-grained PATs):

  • Contents: Read — clone only
  • Contents: Read and write — push changes and create pull requests

‼️ To generate pull requests you also need GitHub MCP server access — the github_repository resource gives filesystem access only. See shared/managed-agents-tools.md → MCP Servers. The PR workflow is: edit files in the mounted repo → push branch via bash → create PR via MCP create_pull_request tool.

TypeScript:

// 1. Create the agent — declare GitHub MCP (no auth here)
const agent = await client.beta.agents.create(
  {
    name: 'GitHub Agent',
    model: '{{OPUS_ID}}',
    mcp_servers: [
      { type: 'url', name: 'github', url: 'https://api.githubcopilot.com/mcp/' },
    ],
    tools: [
      { type: 'agent_toolset_20260401', default_config: { enabled: true } },
      { type: 'mcp_toolset', mcp_server_name: 'github' },
    ],
  },
);

// 2. Start a session — attach vault for MCP auth + mount the repo
const session = await client.beta.sessions.create({
  agent: agent.id,
  environment_id: envId,
  vault_ids: [vaultId],  // vault contains the GitHub MCP OAuth credential
  resources: [
    {
      type: 'github_repository',
      url: 'https://github.com/owner/repo',
      authorization_token: process.env.GITHUB_TOKEN,  // repo clone token (≠ MCP auth)
      checkout: { type: 'branch', name: 'main' },
    },
  ],
});

Python:

import os

agent = client.beta.agents.create(
    name="GitHub Agent",
    model="{{OPUS_ID}}",
    mcp_servers=[{
        "type": "url",
        "name": "github",
        "url": "https://api.githubcopilot.com/mcp/",
    }],
    tools=[
        {"type": "agent_toolset_20260401", "default_config": {"enabled": True}},
        {"type": "mcp_toolset", "mcp_server_name": "github"},
    ],
)

session = client.beta.sessions.create(
    agent=agent.id,
    environment_id=env_id,
    vault_ids=[vault_id],  # vault contains the GitHub MCP OAuth credential
    resources=[{
        "type": "github_repository",
        "url": "https://github.com/owner/repo",
        "authorization_token": os.environ["GITHUB_TOKEN"],  # repo clone token (≠ MCP auth)
        "checkout": {"type": "branch", "name": "main"},
    }],
)

Files API

Upload and manage files for use as session resources, and download files the agent wrote to /mnt/session/outputs/.

Operation Method Path SDK
Upload POST /v1/files client.beta.files.upload({ file })
List GET /v1/files?session_id=... client.beta.files.list({ session_id })
Get Metadata GET /v1/files/{id} client.beta.files.retrieveMetadata(id)
Download GET /v1/files/{id}/content client.beta.files.download(id)Response
Delete DELETE /v1/files/{id} client.beta.files.delete(id)

The session_id filter on List scopes the results to files written to /mnt/session/outputs/ by that session. Without the filter, you get all files uploaded to your account.