Skip to main content
Version: 2025.08

API Reference

The Istari Digital Model Concept Protocol (MCP) Service provides structured access to system, resource, and job operations within the Istari platform.

It is organized into three categories:

  • System Tools: Manage systems, snapshots, and configurations.
  • Resource Tools: Handle models and artifacts.
  • Job Tools: Run automated analysis and processing.

System Tools​

Search for Systems​

Find systems by name, ID, or other filters.

Use this to:

  • Browse systems you’ve created
  • Filter by name or ID
  • Control archived vs active results

Input Options:

  • System Name(s)
  • System ID(s)
  • Paging (page number and size)
  • Archive status
  • Sorting

Returns: A Page of systems

Search System Files​

List all files for a system snapshot, such as requirements or diagrams.

Use this to:

  • View files in a system snapshot
  • Filter by file name or extension
  • Retrieve metadata for traceability

Input Required: System ID
Optional: Snapshot ID, file filters, paging, sorting

Returns: A Page of system revisions.

Create a New System​

Register a new system.

Use this to:

  • Start a new design or program in Istari

Input Required: Name
Optional: Description

Returns: The newly created system.

Update a System​

Edit a system’s name or description.

Use this to:

  • Rename or clarify the purpose of an existing system

Input Required: System ID
Optional: New name or description

Returns: The updated system.

View System Snapshots​

List all snapshots created for a system or configuration.

Use this to:

  • Browse historical versions
  • Track baseline changes over time

Input Options:

  • System ID
  • Configuration ID
  • Tag (e.g. “baseline”)
  • Paging and sorting

Returns: A list of system snapshots.

Create a Snapshot​

Generate a new snapshot for a configuration.

Use this to:

  • Freeze a version of a system at a point in time

Input Required: Configuration ID

Returns: The new snapshot metadata.

Add Files to a System​

Create a new system configuration by attaching existing files that a user has previously uploaded to Istari.

Use this to:

  • Build a system configuration from files already in Istari

Input Required:

  • System ID
  • File IDs

Optional: Configuration name

Returns: The new configuration that tracks the selected files.

Resource Tools​

Search Resources​

Search across all models and artifacts in the Istari registry.

Use this to:

  • Find resources by ID, name, file type, and description
  • Filter by model vs artifact
  • Locate specific versions or file types

Returns: A list of matching resources with metadata.

Download File Contents​

Download a file’s contents using its File ID.

Use this to:

  • Retrieve Excel, CSV, JSON, images, etc., for local use

Returns: The raw file contents.

Get Resource by File ID​

Look up the model or artifact associated with a file.

Use this to:

  • Trace a file to its resource
  • Understand the file’s context in the system

Returns: The linked model or artifact.

Create a Model​

Upload a new model from a local file.

Use this to:

  • Add digital engineering models, analysis data, requirements, or reports to the platform

Input Required: Local file path

Optional: Metadata (description, version name, tags)

Returns: The created model.

Update a Model​

Update the contents of an existing model.

Use this to:

  • Upload a revised version of an existing model

Input Required: Model ID and new file path
Optional: Metadata updates

Returns: The updated model.

Job Tools​

Run Extraction​

Trigger the Istari extraction engine to generate structured data from a model.

Use this to:

  • Extract data from models to produce artifacts

Input Required: Model ID

Returns: The updated model with generated artifacts and job metadata.