Skip to content

Commit 6c702ba

Browse files
committed
Update documentation and visuals for aas-cli and aas-mcp integration
Revised feature descriptions in `README` and `index.md` to reflect `aas-cli` and `aas-mcp` updates. Added MCP-Server mention in overviews. Updated documentation visuals with new banners for CLI and MCP.
1 parent 1003220 commit 6c702ba

File tree

7 files changed

+92
-20
lines changed

7 files changed

+92
-20
lines changed

README.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,7 @@
1313
<b>Documentation</b>: <a href="https://shellsmith.pages.dev/" target="_blank">https://shellsmith.pages.dev</a>
1414
</p>
1515

16-
**Shellsmith** is a Python SDK and CLI for managing [Asset Administration Shells (AAS)](https://industrialdigitaltwin.org/en/content-hub/aasspecifications), Submodels, and Submodel Elements via the [Eclipse BaSyx](https://www.eclipse.org/basyx/) REST API.
17-
18-
It provides full client-side access to AAS resources with a clean Python interface and a powerful `typer`-based CLI — ideal for scripting, automation, and digital twin integration workflows.
16+
**Shellsmith** is a Python SDK for managing [Asset Administration Shells (AAS)](https://industrialdigitaltwin.org/en/content-hub/aasspecifications) via the [Eclipse BaSyx](https://www.eclipse.org/basyx/) REST API.
1917

2018
## Installation
2119

@@ -31,7 +29,6 @@ pip install shellsmith[cli,mcp]
3129

3230
**Requires**: Python 3.10+
3331

34-
3532
## Python API Usage
3633

3734
You can also use `shellsmith` as a Python client library to interact with the BaSyx Environment REST API.

docs/cli.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<div style="margin: 2rem auto 1rem auto; text-align: center;">
2+
<img src="../images/banner-aas-cli-purple-h167.png" alt="Shellsmith logo">
3+
</div>
4+
15
# Command-Line Interface
26

37
**aas-cli** provides a powerful Typer-based command-line interface for interacting with Asset Administration Shells through the Shellsmith ecosystem.
11.4 KB
Loading
Lines changed: 80 additions & 0 deletions
Loading
11.9 KB
Loading

docs/index.md

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@
1111
A Python SDK for managing AAS resources.
1212
</div>
1313

14-
**Shellsmith** is a Python SDK and CLI for managing [Asset Administration Shells (AAS)](https://industrialdigitaltwin.org/en/content-hub/aasspecifications), Submodels, and Submodel Elements via the [Eclipse BaSyx](https://www.eclipse.org/basyx/) REST API.
14+
**Shellsmith** is a Python SDK for managing [Asset Administration Shells (AAS)](https://industrialdigitaltwin.org/en/content-hub/aasspecifications) via the [Eclipse BaSyx](https://www.eclipse.org/basyx/) REST API.
1515

16-
It provides full client-side access to AAS resources through a clean Python interface and a robust command-line tool, making it ideal for scripting, automation, and digital twin integration workflows.
16+
It provides full client-side access to AAS resources through a clean Python interface, an MCP-Server, and a robust command-line tool, making it ideal for scripting, automation, and digital twin integration workflows.
1717

1818
<!-- termynal -->
1919

@@ -22,16 +22,3 @@ $ pip install shellsmith
2222
---> 100%
2323
Successfully installed shellsmith
2424
```
25-
26-
---
27-
28-
## Features
29-
30-
- Python SDK for full CRUD access to AAS resources
31-
- CLI powered by [Typer](https://typer.tiangolo.com/)
32-
- `.env`-based configuration
33-
- Seamless integration with Eclipse BaSyx
34-
35-
---
36-
37-
Use the top navigation to explore the Python API, CLI, MCP-Server, and development setup.

docs/mcp.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# 🤖 MCP Integration
1+
<div style="margin: 2rem auto 1rem auto; text-align: center;">
2+
<img src="../images/banner-aas-mcp-purple-h167.png" alt="Shellsmith logo">
3+
</div>
4+
5+
# MCP Integration
26

37
**aas-mcp** provides a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server that enables AI assistants to interact with Asset Administration Shells through the Shellsmith ecosystem.
48

0 commit comments

Comments
 (0)