Catalog PyPI
Back to packageRELEASE DETAILS

0.0.1

PyPI

aas-mcp

A Python Model Context Protocol (MCP) Server for Eclipse BaSyx to manage Asset Administration Shells (AAS)

Published16 Sept 2025
Direct dependencies5
Transitive dependenciesNot calculated

README

Version 0.0.1 documentation
aas-mcp
PyPI - Version Ruff

aas-mcp is a Model Context Protocol (MCP) server that provides AI assistants with tools to interact with Asset Administration Shells (AAS) via the Eclipse BaSyx REST API.

This MCP server enables AI assistants to perform full CRUD operations on AAS Shells, Submodels, and Submodel Elements, making it ideal for industrial automation, digital twin management, and AAS-based workflows.

Features

  • 🤖 MCP Server with 25+ tools for comprehensive AAS management
  • 🔧 Full CRUD Operations on Shells, Submodels, and Submodel Elements
  • ⚙️ Health Monitoring tools for AAS environment status
  • 🔁 Seamless Integration with Eclipse BaSyx Environment REST API
  • 📡 AI-Ready tools designed for intelligent automation workflows

🚀 Installation

pip install aas-mcp

Requires: Python 3.10+

🚀 Usage

Running the MCP Server

# Start the MCP server
aas-mcp

Available Tools

The MCP server provides 25+ tools for AAS management:

Shell Management

  • get_shells - Retrieve all AAS Shells
  • get_shell - Get a specific Shell by ID
  • create_shell - Create a new Shell
  • update_shell - Update an existing Shell
  • delete_shell - Delete a Shell

Submodel Management

  • get_submodels - Retrieve all Submodels
  • get_submodel - Get a specific Submodel by ID
  • create_submodel - Create a new Submodel
  • update_submodel - Update an existing Submodel
  • delete_submodel - Delete a Submodel
  • get_submodel_value - Get Submodel raw value
  • update_submodel_value - Update Submodel value
  • get_submodel_metadata - Get Submodel metadata

Submodel Element Management

  • get_submodel_elements - Get all elements from a Submodel
  • get_submodel_element - Get a specific element by path
  • create_submodel_element - Create a new element
  • update_submodel_element - Update an existing element
  • delete_submodel_element - Delete an element
  • get_submodel_element_value - Get element raw value
  • update_submodel_element_value - Update element value

Reference Management

  • get_submodel_refs - Get Submodel references from a Shell
  • create_submodel_ref - Create a Submodel reference
  • delete_submodel_ref - Delete a Submodel reference

Health & Monitoring

  • get_health_status - Check AAS environment health
  • is_healthy - Boolean health check

🔧 Configuration

MCP Client Configuration

To use this server with MCP clients like Claude Desktop, add it to your client's configuration:

{
  "mcpServers": {
    "aas-mcp": {
      "command": "aas-mcp",
      "env": {
        "SHELLSMITH_BASYX_ENV_HOST": "http://localhost:8081"
      }
    }
  }
}

ℹ️ Change the value of SHELLSMITH_BASYX_ENV_HOST to match your BaSyx Environment host URL

The configuration format is similar for other MCP clients like LM Studio.

BaSyx Environment Configuration

The MCP server connects to an Eclipse BaSyx environment. The default host is:

http://localhost:8081

You can override it in several ways:

  • Set the environment variable:

    export SHELLSMITH_BASYX_ENV_HOST=https://your-host:1234
    
  • Create a .env file in your working directory with:

    SHELLSMITH_BASYX_ENV_HOST=https://your-host:1234
    

Each tool also accepts a host parameter to override the default configuration dynamically.

🤝 Contributing

We welcome contributions! Please see our contributing guidelines for setup, testing, and coding standards.

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 5

Native requirements
5 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
fastmcp
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
fastmcpruntime
shellsmith
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
shellsmith>=0.4.0runtime
mypy
Environment
{
  "extras": "",
  "marker": "extra == \"test\"",
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
mypy; extra == "test"runtime
pytest
Environment
{
  "extras": "",
  "marker": "extra == \"test\"",
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
pytest; extra == "test"runtime
ruff
Environment
{
  "extras": "",
  "marker": "extra == \"test\"",
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
ruff; extra == "test"runtime

Distribution files

2 collected
aas_mcp-0.0.1-py3-none-any.whl

bdist_wheel · 7.24 KB · Python py3

Source file
aas_mcp-0.0.1.tar.gz

sdist · 6 KB · Python source

Source file

Repository

PENDING
smartfactory-kl/aas-mcp

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 17:04 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:8a9b0ae4e86b6cbacf46c8a99ac572d94316b05be0f11de093ec1bebd3368b98

Other collected versions

View all collected versions →