Skip to content

Commit 4d09d3e

Browse files
Update README.md
1 parent aeeb145 commit 4d09d3e

1 file changed

Lines changed: 11 additions & 29 deletions

File tree

README.md

Lines changed: 11 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,29 @@
1-
# AdaMCP
1+
# AdaMCP - MCP Server for AdaEngine
22

33
`AdaMCP` exposes a live AdaEngine application as an MCP server. It is built for inspection-first workflows: world/entity/resource introspection, render capture, and AdaUI tree inspection with a small set of safe UI actions.
44

5-
## Modules
6-
7-
- `AdaMCPCore`: runtime surface, type introspection, AdaUI inspection, and tool/resource payloads.
8-
- `AdaMCPServer`: MCP server bootstrapping plus HTTP and stdio transports.
9-
- `AdaMCPPlugin`: AdaEngine plugin for embedding `AdaMCP` directly into an app.
10-
11-
## Current platform support
12-
13-
`AdaMCP` currently ships for Apple platforms used by AdaEngine hosts today: `macOS 15+`, `iOS 18+`, `tvOS 18+`, and `visionOS 2+`.
5+
## Current platform support
146

157
The important distinction is:
168

179
- MCP clients can live anywhere and connect over HTTP or stdio.
1810
- The host runtime now builds on the broader Apple surface, while `stdio` remains primarily a local host transport and HTTP is the main cross-device option.
1911

20-
So `SloppyClient` no longer needs a `macOS`-only gate just to embed the MCP plugin.
21-
22-
## What you get
12+
## What you get 🌸
2313

24-
- World, entity, component, resource, and asset inspection.
25-
- Screenshot capture for live render output.
26-
- AdaUI inspection tools such as `ui.list_windows`, `ui.get_tree`, `ui.get_node`, `ui.find_nodes`, and `ui.hit_test`.
27-
- AdaUI diagnostics and safe actions such as focus traversal, deterministic tap, and scroll-to-node.
28-
- MCP resources under `ada://...`, including `ada://ui/windows`, `ada://ui/window/{id}`, `ada://ui/tree/{id}`, and `ada://ui/node/{windowId}/{nodeRef}`.
14+
- 😳 World, entity, component, resource, and asset inspection.
15+
- 📸 Screenshot capture for live render output.
16+
- 💉 AdaUI inspection tools such as `ui.list_windows`, `ui.get_tree`, `ui.get_node`, `ui.find_nodes`, and `ui.hit_test`.
17+
- 🧑‍🏫 AdaUI diagnostics and safe actions such as focus traversal, deterministic tap, and scroll-to-node.
18+
- 📦 MCP resources under `ada://...`, including `ada://ui/windows`, `ada://ui/window/{id}`, `ada://ui/tree/{id}`, and `ada://ui/node/{windowId}/{nodeRef}`.
2919

30-
## Embedding in an AdaEngine app
20+
## Embedding in an AdaEngine app ⚒️
3121

3222
Until the package is published, add it as a local SwiftPM dependency:
3323

3424
```swift
3525
dependencies: [
36-
.package(url: "https://github.com/AdaEngine/AdaMCP", branch: "main")
26+
.package(url: "https://github.com/AdaEngine/AdaMCP.git", branch: "main")
3727
]
3828
```
3929

@@ -54,7 +44,7 @@ struct ExampleApp: App {
5444
enableHTTP: true,
5545
enableStdio: true,
5646
host: "127.0.0.1",
57-
port: 25102,
47+
port: 2510,
5848
endpoint: "/mcp",
5949
serverName: "example-app",
6050
serverVersion: "0.1.0",
@@ -65,14 +55,6 @@ struct ExampleApp: App {
6555
}
6656
```
6757

68-
## Runtime architecture
69-
70-
`AdaMCP` is split into three layers:
71-
72-
1. `AdaMCPRuntime` builds tool/resource payloads from live AdaEngine and AdaUI state.
73-
2. `AdaMCPServerFactory` exposes that runtime through the official MCP Swift SDK.
74-
3. `MCPPlugin` wires the runtime into an AdaEngine app and starts HTTP and/or stdio transports.
75-
7658
## AdaUI surface
7759

7860
AdaUI support is intentionally inspection-first. The main flow is:

0 commit comments

Comments
 (0)