Skip to content

Agreement Overview

1. Definition (No Inheritance Yet)

Agreement defines the interaction contract between business systems and agents. Inheritance is not supported in the current model.

2. Specification Shape

Recommended structure (implementation-oriented):

  • Top-level: name, version, description, via, tags, interface
  • interface.userCache[]: user cache key definitions
  • interface.functions[]: function contracts (request/response/error/idempotency, etc.)

Version publishing path:

agreements/<agreement-name>/<version>/agreement.json

3. Templates

  • auth: start from agreements/auth/<version>/agreement.json
  • oauth: start from agreements/oauth/<version>/agreement.json
  • payment: start from agreements/payment/<version>/agreement.json
  • try: start from agreements/try/<version>/agreement.json