API reference

Kward's generated Ruby API documentation is for contributors, plugin authors, tool authors, and people building RPC or editor integrations.

If you use Kward from the terminal, start with the user guides. This reference also includes internal classes and methods that may change. Treat the behavior described in the guides, the Plugin DSL, and the methods in the RPC protocol as Kward's supported public interfaces.

Start here

• Classes and modules: searchable index of generated Ruby constants.
• Methods: searchable index of generated Ruby methods.
• Files: generated file index.
• Top-level Kward namespace: root namespace for the generated reference.

Start by role

Plugin authors

Use plugins when you need trusted local Ruby code for slash commands, prompt context, footer UI, transcript events, or RPC-visible commands.

Read first:

• Plugins
• Extensibility

Generated entry points:

• Kward.plugin
• Kward::PluginRegistry
• Kward::PluginRegistry::DSL
• Kward::PluginRegistry::Context

Tool authors and contributors

Built-in tools are Ruby classes registered with Kward's tool registry. They expose schemas to the model and execute bounded local operations.

Read first:

• Usage
• Web search
• Code search

Generated entry points:

• Kward::Tools
• Kward::Tools::Base
• Kward::ToolRegistry

These pages document the schema and dispatch contract used by built-in tools. Kward does not yet provide a plugin DSL for registering arbitrary model-callable tools; contributors add them through the built-in registry and keep schemas, validation, docs, and tests aligned.

RPC and frontend authors

The RPC protocol is the supported integration surface for UI clients. Prefer the protocol guide before reading implementation classes.

Read first:

• RPC protocol

Generated entry points:

• Kward::RPC
• Kward::RPC::Server
• Kward::RPC::SessionManager
• Kward::RPC::ToolEventNormalizer

Prompt, skill, and configuration contributors

Prompt templates, skills, personas, and project instructions are user-facing extension points. Prefer the guides for supported behavior, then use the API reference to inspect implementation details.

Read first:

• Extensibility
• Personas
• Configuration

Generated entry points:

• Kward::Prompts
• Kward::Prompts::Templates
• Kward::Skills
• Kward::Skills::Registry
• Kward::ConfigFiles

The generated comments focus on these supported extension boundaries rather than trying to make every internal orchestration helper public. When a generated method lacks guide coverage, treat it as internal unless the page explicitly marks it as a public API.

Public API expectations

The generated reference is useful for understanding the codebase, but it does not make every class, method, or constructor a supported public API.

Prefer the documented guides for supported extension behavior. Use generated class and method pages when you need implementation detail, are contributing to Kward itself, or are coordinating a frontend integration with the current codebase.

As a rule of thumb:

• Guide-documented behavior is the supported user-facing surface.
• Plugin DSL methods are intended extension points.
• RPC JSON-RPC methods documented in RPC protocol are the integration contract for frontend clients.
• Generated classes without guide coverage may be internal implementation details.