@shaykec/appxray-protocol
v0.1.7
Published
Shared protocol types for appxray MCP server and SDKs
Downloads
1,070
Maintainers
Readme
@shaykec/appxray-protocol
Shared protocol types and constants for the appxray ecosystem.
What It Does
This package contains the TypeScript types and JSON-RPC message definitions shared between the appxray MCP server and the appxray SDKs. You typically don't need to install this directly — it's a dependency of the other appxray packages.
When to Use Directly
Install this package if you're building:
- A custom SDK for a platform not yet supported
- A custom MCP tool that extends appxray
- Tests that need appxray protocol types
npm install @shaykec/appxray-protocolKey Types
| Type | Description |
|------|-------------|
| AppInfo | App identity (name, platform, version, port) |
| ComponentNode | UI component tree node with props, state, children |
| StateValue | Named state entry with value and metadata |
| NetworkEntry | Captured HTTP request/response with timing |
| TimelineEvent | Unified event (network, state, render, navigation, error, trace) |
| InteractionResult | Result of a UI interaction (tap, type, swipe) |
| MockRule | API mock rule definition |
| DiagnosticReport | Health check results |
Related Packages
@shaykec/appxray-mcp-server— MCP server@shaykec/appxray-web— Web SDK@shaykec/appxray-node— Node.js SDK@shaykec/appxray-react-native— React Native SDK
License
MIT
