methods

Method Schemas

This directory contains JSON Schema definitions for all standard GABP method calls. Each method has separate schemas for requests and responses.

Core Methods

Session Management

• session.hello.request.json - Initial handshake from bridge
• session.welcome.response.json - Handshake response from mod

Tool Operations

• tools.list.request.json - Request available tools
• tools.list.response.json - List of tool definitions
• tools.call.request.json - Invoke a specific tool
• tools.call.response.json - Tool execution result

Event Management

• events.subscribe.request.json - Subscribe to event channels
• events.unsubscribe.request.json - Unsubscribe from channels

Resource Access

• resources.list.request.json - List available resources
• resources.list.response.json - Resource directory listing
• resources.read.request.json - Read resource content
• resources.read.response.json - Resource data

State Management

• state.get.request.json - Retrieve state components
• state.get.response.json - Current state values
• state.set.request.json - Update state components
• state.set.response.json - State update confirmation

Schema Structure

Each method schema:

• Extends the base envelope schema
• Defines method-specific parameters/results
• Includes validation rules for required fields
• Specifies allowed data types and formats

Usage

Validate method-specific messages:

# Validate a tools/list request
ajv -s tools.list.request.json -d 'example-tools-list.json'

# Validate a session/hello request  
ajv -s session.hello.request.json -d 'example-hello.json'

Custom Methods

When implementing custom methods, follow these patterns:

• Use the envelope structure as a base
• Follow naming conventions from ../../SPEC/1.0/registry.md
• Include proper validation for all parameters
• Define clear input and output schemas