Skip to content

API.md

Latest commit

 

History

History
164 lines (146 loc) · 9.53 KB

API.md

File metadata and controls

164 lines (146 loc) · 9.53 KB
Raw

The API surface

Generated — do not edit. Run make api to rebuild this and api/surface.json from the source.

Mobium's architecture rests on one claim: every front door reaches the same tool layer, so a CLI command and an MCP tool cannot answer differently. This is that claim, enumerated, and a drift check keeps it true — internal/apisurface fails the build if any tool stops being reachable from any surface without the gap being written down.

One level down, FLAGS.md asks whether the CLI and the schema agree about what each tool accepts. Same procedure, same package, same kind of exemption list — and a separate check, because the two questions fail differently.

The numbers
Tools 75
CLI commands registered 84
…visible in mobium --help 83
…hidden 1 (pipe)
Command constructors in source 90 (includes daemon start, stop, status)
Client libraries 5

Those three command counts differ on purpose, and the arithmetic is asserted by a test: registered = visible + hidden, and the constructor count is higher again because daemon has subcommands. Reported as one number, they have been wrong twice.

Every tool, and what reaches it

# Tool CLI Go Python JavaScript Java
1 app_accessibility accessibility Accessibility accessibility accessibility accessibility
2 app_alert alert Alert alert alert alert
3 app_appearance appearance Appearance appearance appearance appearance
4 app_assistant assistant Assistant assistant assistant assistant
5 app_audio audio Audio audio audio audio
6 app_audit audit Audit audit audit audit
7 app_background background Background background background background
8 app_batch batch Batch batch batch batch
9 app_battery battery Battery battery battery battery
10 app_biometric biometric Biometric biometric biometric biometric
11 app_boot boot Boot boot boot boot
12 app_call call IncomingCall incoming_call incomingCall incomingCall
13 app_check check, uncheck Check check check check
14 app_clear_data clear-data ClearData clear_data clearData clearData
15 app_clipboard clipboard Clipboard clipboard clipboard clipboard
16 app_context context Context context context context
17 app_contexts contexts Contexts contexts contexts contexts
18 app_cookies cookies Cookies cookies cookies cookies
19 app_crashes crashes Crashes crashes crashes crashes
20 app_current current Current current current current
21 app_devices devices Devices devices devices devices
22 app_dialogs dialogs AddDialogRule add_dialog_rule addDialogRule addDialogRule
23 app_doctor doctor Doctor doctor doctor doctor
24 app_download download PullPath download download download
25 app_drag drag Drag drag drag drag
26 app_eval eval Eval eval eval eval
27 app_fill fill Fill fill fill fill
28 app_find find Find find find find
29 app_grant grant Grant grant grant grant
30 app_hit_test hit-test HitTest hit_test hitTest hitTest
31 app_hook hook Hook hook hook hook
32 app_install install Install install install install
33 app_keyboard keyboard Keyboard keyboard keyboard keyboard
34 app_launch launch Launch launch launch launch
35 app_list_apps apps Apps apps apps apps
36 app_locale locale AppLocale app_locale appLocale appLocale
37 app_location location Location location location location
38 app_lock lock ScreenLocked screen_locked screenLocked screenLocked
39 app_logs logs Logs logs logs logs
40 app_long_press long-press LongPress long_press longPress longPress
41 app_map map Map map map map
42 app_network network ResetNetwork network network network
43 app_notifications notifications Notifications notifications notifications notifications
44 app_open_url open OpenURL open_url openUrl openUrl
45 app_orientation orientation Orientation orientation orientation orientation
46 app_press press Press press press press
47 app_press_drag press-drag PressDrag press_drag pressDrag pressDrag
48 app_press_tap press-tap PressTap press_tap pressTap pressTap
49 app_record record Record record record record
50 app_reset_permissions reset-permissions ResetPermissions reset_permissions resetPermissions resetPermissions
51 app_revoke revoke Revoke revoke revoke revoke
52 app_rotate rotate Rotate rotate rotate rotate
53 app_screen screen Screen screen screen screen
54 app_screenshot screenshot Screenshot screenshot screenshot screenshot
55 app_scroll_to scroll-to ScrollTo scroll_to scrollTo scrollTo
56 app_session session Start start start start
57 app_shake shake Shake shake shake shake
58 app_shutdown shutdown Shutdown shutdown shutdown shutdown
59 app_sms sms SendSMS sms sms sms
60 app_source source Source source source source
61 app_speech speech Speech speech speech speech
62 app_state state AppState app_state appState appState
63 app_storage storage Storage storage storage storage
64 app_swipe swipe Swipe swipe swipe swipe
65 app_tap tap, double-tap Tap tap tap tap
66 app_terminate terminate Terminate terminate terminate terminate
67 app_text text Text text text text
68 app_time time DeviceTime device_time deviceTime deviceTime
69 app_timezone timezone Timezone timezone timezone timezone
70 app_trace trace TraceStart trace_start traceStart traceStart
71 app_type type Type type type type
72 app_uninstall uninstall Uninstall uninstall uninstall uninstall
73 app_upload upload PushPath upload upload upload
74 app_wait_for wait WaitFor wait_for waitFor waitFor
75 app_zoom zoom Zoom zoom zoom zoom

Client coverage

Client Source Tools reached
go clients/go/mobium.go 75 / 75
python clients/python/mobium/_device.py 75 / 75
javascript clients/javascript/index.js 75 / 75
java clients/java/src/main/java/dev/mobium/Mobium.java 75 / 75
dotnet clients/dotnet/Mobium/Device.cs 75 / 75

Commands that dispatch no tool

  • daemon
  • daemon start
  • daemon status
  • daemon stop
  • daemon up
  • grid
  • grid status
  • grid ui
  • inspect
  • mcp
  • pipe
  • show-report
  • test

These run the process rather than the device — the daemon's own lifecycle, and the two stdio servers. They are listed because a command that reaches no tool is either one of these or an orphan, and from outside the two look identical; a test names them so a new orphan fails rather than blending in.

How drift is prevented

internal/apisurface sweeps the source — not a running binary, so it cannot disagree with what would be built — and asserts:

  1. Every tool is reachable from the CLI. Both dispatch paths count: most commands go through the daemon, while doctor calls the tool layer in-process so it still works with no daemon, no device and nothing on PATH.
  2. Every client reaches every tool. Per client, so a failure names the client rather than a list of tools.
  3. Gaps may exist, but only declared ones. An undeclared gap fails; so does an exemption for a gap that has since been closed, so the list cannot rot into a blanket excuse. It is currently empty.
  4. The sweep can see each surface. A pattern that stopped matching would report a client as covering nothing; that is asserted against, because a drift check that fails open is worse than none.

The first thing this found, on the day it was written, was real: doctor existed in the Java client and in none of the other three. Nothing had compared them before.