Quickstart

Prerequisites

Install and sign in to Nexus

Open the Nexus app and sign in. The SDK drives this running app, so it must be open while your code runs.

Turn on Developer access

In Settings → Developer access, enable it. This starts the local MCP server the SDK connects to and writes a per-user descriptor the SDK discovers automatically.

Install the SDK

pip install cosmon-agent-sdk

Requires Python 3.10+.

Check the connection

cosmon doctor

This confirms the app is reachable, you’re signed in, and the agent runtime is ready. A healthy check looks like this:

Cosmon Agent SDK — connection check

  descriptor (default): ~/Library/Application Support/nexus/mcp-gateway.json
  ✓ reached the app
  ✓ signed in (you@company.com)
  ✓ agent runtime ready
  ✓ tool server ready
      agents: nexus, solidworks, abaqus, fluent, ansys_mechanical, comsol
      model:  claude-sonnet-5

Ready. Try:  cosmon run "what can you do?"

Any line marked ✗ tells you what to fix — re-check that the app is open, you’re signed in, and Developer access is on.

Your first run

from cosmon_agent_sdk import Client

with Client() as client:
    answer = client.run(
        "What is the peak von Mises stress in bracket.sldprt?",
        agent="solidworks",
    ).text()
    print(answer)

Client() discovers the running app and connects — no endpoint or key to configure. client.run(...) starts an agent run and returns a Run; .text() drives it to completion and returns the run’s transcript — the answer plus each tool step as a ▶ line. Add live=True to watch it print while you wait. The printed transcript looks like this — the ▶ lines are the tool steps the agent took, and the prose is its answer:

▶ Open bracket.sldprt

▶ Run static structural study

The peak von Mises stress is 187.4 MPa, at the inner fillet of the mounting
lug. With the yield strength of the assigned material (AISI 1020, ~350 MPa),
that's a safety factor of ~1.9.

Streaming the work as it happens

Instead of .text(), iterate the run to see it live. It yields typed events — ToolCall (a tool-call boundary) and TextChunk (the answer, as it streams):

import sys
from cosmon_agent_sdk import Client, TextChunk, ToolCall

with Client() as client:
    for event in client.run("Open bracket.sldprt and summarize the part", agent="solidworks"):
        if isinstance(event, TextChunk):
            print(event.text, end="", flush=True)          # answer, token by token
        elif isinstance(event, ToolCall) and not event.finished:
            print(f"[{event.summary}]", file=sys.stderr)    # tool steps

Iterate or call .text() — a run is single-use. The TextChunks reconstruct the same answer .text() returns; iterating just lets you render it (and the tool steps) as it arrives.

Picking an agent

Pass agent= to target a platform: "solidworks", "abaqus", "fluent", "ansys_mechanical", "comsol", … Omit it to use the default agent. Run cosmon doctor to see which agents your app exposes.

Next steps

Guide

Attended vs unattended, answering the agent with handlers, and batch runs.

Examples

Runnable scripts for every capability — copy, run, adapt.

Python reference

The full API surface, async client, streaming, and errors.

Command line

The cosmon CLI — doctor, run, and chats from the shell.

Getting Started

CAD

CAE

Agent SDK

Deployment

Prerequisites

Your first run

Streaming the work as it happens

Picking an agent

Next steps

Guide

Examples

Python reference

Command line

​Prerequisites

​Your first run

​Streaming the work as it happens

​Picking an agent

​Next steps

Guide

Examples

Python reference

Command line

Prerequisites

Your first run

Streaming the work as it happens

Picking an agent

Next steps