Liking cljdoc? Tell your friends :D

hive-addon.capability

Capability contract vocabulary: the declared, machine-readable description of what one MCP tool's commands are, what they accept, and how stable they are.

Contract: a manifest is DATA. It holds no handlers and never dereferences a :schema — schema refs are registry keys, resolved by hive-spi.schema.capability. Deps: hive-dsl + malli only.

Capability contract vocabulary: the declared, machine-readable description of
what one MCP tool's commands are, what they accept, and how stable they are.

Contract: a manifest is DATA. It holds no handlers and never dereferences a
:schema — schema refs are registry keys, resolved by hive-spi.schema.capability.
Deps: hive-dsl + malli only.
raw docstring

->declaration-statusclj/s

(->declaration-status kw__6129__auto__)

Coerce a keyword to a DeclarationStatus variant (no data fields). Returns nil if keyword is not a valid variant.

Coerce a keyword to a DeclarationStatus variant (no data fields).
Returns nil if keyword is not a valid variant.
sourceraw docstring

->effectclj/s

(->effect kw__6129__auto__)

Coerce a keyword to a Effect variant (no data fields). Returns nil if keyword is not a valid variant.

Coerce a keyword to a Effect variant (no data fields).
Returns nil if keyword is not a valid variant.
sourceraw docstring

->stabilityclj/s

(->stability kw__6129__auto__)

Coerce a keyword to a Stability variant (no data fields). Returns nil if keyword is not a valid variant.

Coerce a keyword to a Stability variant (no data fields).
Returns nil if keyword is not a valid variant.
sourceraw docstring

AliasSpecclj/s

Value of the :aliases ENTRY-property on an op-schema param. Either a bare alias keyword or a map carrying deprecation metadata. Aliases fold to canonical BEFORE validation and render in help; they are never emitted as separate JSON-Schema properties.

Value of the :aliases ENTRY-property on an op-schema param. Either a bare
alias keyword or a map carrying deprecation metadata. Aliases fold to
canonical BEFORE validation and render in help; they are never emitted as
separate JSON-Schema properties.
sourceraw docstring

CapabilityManifestclj/s

One tool's capability surface, contributed by one owner.

:all-commands is the addon's LIVE dispatch key set — handler keys plus any cond-intercepted command such as "help".

Two invariants beyond the map shape: no duplicate :command, and every declared :command is a member of :all-commands.

One tool's capability surface, contributed by one owner.

:all-commands is the addon's LIVE dispatch key set — handler keys plus any
cond-intercepted command such as "help".

Two invariants beyond the map shape: no duplicate :command, and every
declared :command is a member of :all-commands.
sourceraw docstring

command-enumclj/s

(command-enum manifest)

manifest -> the CLOSED command enum schema [:enum & sorted :all-commands]. The single source of a tool's command list.

manifest -> the CLOSED command enum schema [:enum & sorted :all-commands].
The single source of a tool's command list.
sourceraw docstring

CommandExampleclj/s

A runnable invocation. :args is lint-validated against the command's resolved :schema.

A runnable invocation. :args is lint-validated against the command's
resolved :schema.
sourceraw docstring

CommandNameclj/s

A dispatch token exactly as the caller spells it. NOT kebab-constrained: "write-form", "carto_definition" and space-joined "action redo to" are all valid. 1-64 chars, no leading, trailing or doubled whitespace. Shape conventions are a lint rule, not a validity gate.

A dispatch token exactly as the caller spells it. NOT kebab-constrained:
"write-form", "carto_definition" and space-joined "action redo to" are all
valid. 1-64 chars, no leading, trailing or doubled whitespace. Shape
conventions are a lint rule, not a validity gate.
sourceraw docstring

CommandSpecclj/s

ONE dispatchable subcommand.

:schema is OPTIONAL — a command is declarable by summary alone, and the absence of :schema IS :capability/undeclared.

:handler is deliberately ABSENT: a manifest carries no live fns.

:summary is bounded at 8-160 chars.

ONE dispatchable subcommand.

:schema is OPTIONAL — a command is declarable by summary alone, and the
absence of :schema IS :capability/undeclared.

:handler is deliberately ABSENT: a manifest carries no live fns.

:summary is bounded at 8-160 chars.
sourceraw docstring

coverageclj/s

(coverage manifest)

manifest -> {:tool :total :declared :schematized :undeclared :declared-pct :schematized-pct}. Percentages are 1.0 when the tool dispatches nothing.

manifest -> {:tool :total :declared :schematized :undeclared
             :declared-pct :schematized-pct}. Percentages are 1.0 when the
tool dispatches nothing.
sourceraw docstring

declaration-statusclj/s

(declaration-status variant-kw__6126__auto__)
(declaration-status variant-kw__6126__auto__ data__6127__auto__)

Construct a DeclarationStatus variant. (declaration-status variant-keyword) for enum variants (declaration-status variant-keyword data-map) for data variants

Throws ex-info for unknown variants.

Construct a DeclarationStatus variant.
(declaration-status variant-keyword) for enum variants
(declaration-status variant-keyword data-map) for data variants

Throws ex-info for unknown variants.
sourceraw docstring

declaration-status?clj/s

(declaration-status? x__6128__auto__)

True if x is a DeclarationStatus ADT value.

True if x is a DeclarationStatus ADT value.
sourceraw docstring

DeclarationStatusclj/s

Declaration state of a command. Derived, never declared.

Declaration state of a command. Derived, never declared.
sourceraw docstring

declaredclj/s

(declared manifest)

manifest -> set of command names carrying a CommandSpec.

manifest -> set of command names carrying a CommandSpec.
sourceraw docstring

default-envelopeclj/s

Cross-cutting keys present on EVERY call that no op-schema declares: :command/:timeout/:timeout-ms from the dispatcher, :agent_id/:_caller_cwd injected by bb-mcp. Subtracted before any unknown-key report.

Cross-cutting keys present on EVERY call that no op-schema declares:
:command/:timeout/:timeout-ms from the dispatcher, :agent_id/:_caller_cwd
injected by bb-mcp. Subtracted before any unknown-key report.
sourceraw docstring

Effectclj/s

What invoking a command can touch.

What invoking a command can touch.
sourceraw docstring

effectclj/s

(effect variant-kw__6126__auto__)
(effect variant-kw__6126__auto__ data__6127__auto__)

Construct a Effect variant. (effect variant-keyword) for enum variants (effect variant-keyword data-map) for data variants

Throws ex-info for unknown variants.

Construct a Effect variant.
(effect variant-keyword) for enum variants
(effect variant-keyword data-map) for data variants

Throws ex-info for unknown variants.
sourceraw docstring

effect?clj/s

(effect? x__6128__auto__)

True if x is a Effect ADT value.

True if x is a Effect ADT value.
sourceraw docstring

EffectKwclj/s

Enum schema over effects.

Enum schema over `effects`.
sourceraw docstring

effectsclj/s

Set of every :effect/* variant keyword.

Set of every :effect/* variant keyword.
sourceraw docstring

explain-manifestclj/s

x -> malli explanation map, or nil when x conforms to CapabilityManifest.

x -> malli explanation map, or nil when x conforms to CapabilityManifest.
sourceraw docstring

indexclj/s

(index manifest)

manifest -> {command-name CommandSpec}.

manifest -> {command-name CommandSpec}.
sourceraw docstring

manifest-schemasclj/s

Mirror bundle {registry-key schema} for a host to register under :hive.capability/*. hive-addon never registers into hive-spi itself.

Mirror bundle {registry-key schema} for a host to register under
:hive.capability/*. hive-addon never registers into hive-spi itself.
sourceraw docstring

schematizedclj/s

(schematized manifest)

manifest -> set of command names whose CommandSpec carries a :schema.

manifest -> set of command names whose CommandSpec carries a :schema.
sourceraw docstring

stabilitiesclj/s

Set of every :stability/* variant keyword.

Set of every :stability/* variant keyword.
sourceraw docstring

Stabilityclj/s

Lifecycle position of a command.

Lifecycle position of a command.
sourceraw docstring

stabilityclj/s

(stability variant-kw__6126__auto__)
(stability variant-kw__6126__auto__ data__6127__auto__)

Construct a Stability variant. (stability variant-keyword) for enum variants (stability variant-keyword data-map) for data variants

Throws ex-info for unknown variants.

Construct a Stability variant.
(stability variant-keyword) for enum variants
(stability variant-keyword data-map) for data variants

Throws ex-info for unknown variants.
sourceraw docstring

stability?clj/s

(stability? x__6128__auto__)

True if x is a Stability ADT value.

True if x is a Stability ADT value.
sourceraw docstring

StabilityKwclj/s

Enum schema over stabilities.

Enum schema over `stabilities`.
sourceraw docstring

statusclj/s

(status {:keys [schema]})

CommandSpec -> :capability/declared when it carries a :schema, else :capability/undeclared.

CommandSpec -> :capability/declared when it carries a :schema, else
:capability/undeclared.
sourceraw docstring

undeclaredclj/s

(undeclared manifest)

manifest -> set of dispatchable command names with no CommandSpec.

manifest -> set of dispatchable command names with no CommandSpec.
sourceraw docstring

valid-manifest?clj/s

x -> boolean. Compiled CapabilityManifest validator.

x -> boolean. Compiled CapabilityManifest validator.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close