A Python Model Context Protocol (MCP) Server for Eclipse BaSyx to manage Asset Administration Shells (AAS)
Project description
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 Shellsget_shell- Get a specific Shell by IDcreate_shell- Create a new Shellupdate_shell- Update an existing Shelldelete_shell- Delete a Shell
Submodel Management
get_submodels- Retrieve all Submodelsget_submodel- Get a specific Submodel by IDcreate_submodel- Create a new Submodelupdate_submodel- Update an existing Submodeldelete_submodel- Delete a Submodelget_submodel_value- Get Submodel raw valueupdate_submodel_value- Update Submodel valueget_submodel_metadata- Get Submodel metadata
Submodel Element Management
get_submodel_elements- Get all elements from a Submodelget_submodel_element- Get a specific element by pathcreate_submodel_element- Create a new elementupdate_submodel_element- Update an existing elementdelete_submodel_element- Delete an elementget_submodel_element_value- Get element raw valueupdate_submodel_element_value- Update element value
Reference Management
get_submodel_refs- Get Submodel references from a Shellcreate_submodel_ref- Create a Submodel referencedelete_submodel_ref- Delete a Submodel reference
Health & Monitoring
get_health_status- Check AAS environment healthis_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_HOSTto 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
.envfile 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file aas_mcp-0.0.1.tar.gz.
File metadata
- Download URL: aas_mcp-0.0.1.tar.gz
- Upload date:
- Size: 6.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ec2ebf7ced4ef839334f7012d2eef0f1eee1b547b9b6d476dd077ef588b0112f
|
|
| MD5 |
bc7d1fcb2ff2f6ea71ff2b3d6cc42f81
|
|
| BLAKE2b-256 |
c51ccb4c1e0b6d110d889d920135af3083ecbdda47f6833dbc6f7b72501851bd
|
File details
Details for the file aas_mcp-0.0.1-py3-none-any.whl.
File metadata
- Download URL: aas_mcp-0.0.1-py3-none-any.whl
- Upload date:
- Size: 7.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ad4759b346e56909bb75a299d02ab42a5b646dec24b64ce2b475d0d1340adcd5
|
|
| MD5 |
a894d257291b6e31233ce15f8974a36c
|
|
| BLAKE2b-256 |
c340caa13d457942834cb93759469a9d3d81bd110b68cb1dcf3765c0736447dc
|