Innovating with Capella

Clone Capella Repo

Clone a GitHub repository containing a Capella model. Returns a session_id used by all subsequent tools. If the model depends on library repos, call add_dependency_repo next. Args: repo_url: HTTPS URL of the GitHub repository (e.g. https://github.com/owner/repo or https://github.com/owner/repo.git) github_pat: GitHub personal access token with repo read access branch: Git branch to clone (default: repo's default branch) include_real

Browse Model

List all objects of a given type within a Capella model phase. Call list_object_types() first to see valid phase/object_type combinations. object_type matching is case-insensitive (e.g. "functional chain" works). Args: session_id: Session ID returned by clone_capella_repo phase: One of OA, SA, LA, PA object_type: Object type within that phase — call list_object_types() for valid values

Search Model Objects

Search model objects by name (case-insensitive substring match). Call list_object_types() first to see valid phase/object_type combinations. object_type matching is case-insensitive (e.g. "functional chain" works). Args: session_id: Session ID returned by clone_capella_repo phase: One of OA, SA, LA, PA object_type: Object type within that phase — call list_object_types() for valid values name_query: Substring to match against object names

Resolve Model Uuids

Resolve UUIDs to model objects and save them to the session for fabric generation. Args: session_id: Session ID returned by clone_capella_repo uuids: List of Capella object UUIDs to resolve

Generate Fabric

Generate a YAML fabric for the resolved UUIDs in the session. Call resolve_model_uuids (or browse_model) first to populate the UUID list. Args: session_id: Session ID returned by clone_capella_repo

Add Dependency Repo

Clone a dependency library repository and register it with the session. Call after clone_capella_repo, before browse_model or generate_fabric. resource_name must match the name used in the main model's cross-references (e.g. "Bike BrakeSystem Library"). Can be called multiple times for multiple libraries. Args: session_id: Session ID returned by clone_capella_repo repo_url: HTTPS URL of the dependency repository github_pat: GitHub PAT with rep

List Object Types

Return all valid phase and object_type values for browse_model and search_model_objects. Call this before browse_model if unsure what object types exist for a phase. Returns a dict mapping phase (OA/SA/LA/PA) to a list of valid object_type strings. No session required.

Apply Model Patch

Apply a declarative YAML patch to the Capella model, save, and git-commit. Uses py-capellambse's decl.apply() format. Target existing elements with `!uuid <uuid>` and use `set:` to update properties or `extend:` to add children. Use `promise_id:` / `!promise` for forward-references within the same patch. See this server's own `instructions` (returned at connection time) for the full `_type` auto-injection rules (function/activity, component, property-value), the PA-phase

Push Model Changes

Push all committed model changes to the remote GitHub repository. Call after one or more apply_model_patch calls when ready to persist. The session's git remote already carries credentials from clone_capella_repo. Args: session_id: Session ID from clone_capella_repo.

Verify Model

Scan a model phase for common quality issues. Checks performed: - Elements with missing or empty names - Functions not allocated to any component (SA / LA / PA) Returns findings grouped by category with object info for each issue. An empty findings dict means no issues were found. Args: session_id: Session ID from clone_capella_repo. phase: OA, SA, LA, or PA.

Cleanup Session

Delete the cloned repository and all session temp files. Args: session_id: Session ID returned by clone_capella_repo