Skip to content

Schema: tools and side-effect contracts #90

Description

@rajanbor

Goal

Define library/schemas/tool.schema.json for tools an AI agent may invoke.

Human contract

Explain purpose, inputs, outputs, authentication, permissions, side effects, idempotency, timeout, retry policy, failure modes, redaction, and audit evidence. Include read-only and state-changing examples.

Machine contract

Use typed input/output schema references and explicit side-effect classes. Require confirmation or escalation for destructive or externally visible actions. Define retryable errors and idempotency without vendor-specific fields.

Acceptance criteria

  • Schema, guide, valid examples, and unsafe invalid fixtures exist.
  • A mutating tool cannot omit side effects or recovery behavior.
  • Secret fields are marked and excluded from logs/examples.
  • Agent references to tools can be validated.
  • Tests cover timeout, retry, and idempotency constraints.

Depends on the document envelope and aligns with the agent schema.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority: highHigh-leverage / cornerstone patterntype: featureNon-pattern feature — website, tooling, templatestype: schemaMachine-readable contract with a human-readable guide

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions