Skip to content

@codesoul-co/hypha-tools API

Tool contracts, registries, governed execution and workspace boundaries.

  • Install: npm install @codesoul-co/hypha-tools@1.0.1
  • Entrypoint import: import { ... } from '@codesoul-co/hypha-tools';
  • Public exports: 263
  • Source modules: 11

Export overview

KindCount
class21
constant76
function26
interface120
type20

Source modules

ModuleUse whenExportsSource
adapter-factoryUse the Adapter factory module for binding external or local providers to Hypha ports. It exports 2 classes, 3 constants, 3 functions, 8 interfaces, 1 type.17source
common-tool-catalogUse the Common tool catalog module for registering and resolving versioned capabilities or implementations. It exports 2 constants, 2 functions, 1 type.5source
common-tool-portsUse the Common tool ports module for defining or implementing provider-neutral ports. It exports 9 constants, 1 function, 4 interfaces.14source
common-toolsUse the Common tools module for using the public contracts and operations for this capability boundary. It exports 6 constants, 5 functions, 2 interfaces, 4 types.17source
contractsUse the Contracts module for declaring and runtime-validating contracts. It exports 38 constants, 4 functions, 32 interfaces, 2 types.76source
execution-adapterUse the Execution adapter module for binding external or local providers to Hypha ports. It exports 2 classes, 1 constant, 3 functions, 10 interfaces, 2 types.18source
indexAggregates the public entrypoint exports for @codesoul-co/hypha-tools; applications import these symbols from the package entrypoint instead of internal file paths.85source
mediaUse the Media module for declaring text, image, audio, and binary Tool inputs and outputs. It exports 4 constants, 2 functions, 10 interfaces, 2 types.18source
secretsUse the Secrets module for passing governed secret references and resolution contracts. It exports 5 interfaces.5source
tool-familiesUse the Tool families module for using the public contracts and operations for this capability boundary. It exports 1 constant, 1 function, 2 interfaces.4source
workspaceUse the Workspace module for declaring and enforcing workspace scope boundaries. It exports 3 interfaces, 1 type.4source

Import boundary

This page documents only the public API exported by the @codesoul-co/hypha-tools package entrypoint. Implementations under packages/tools/src that are not exported from that entrypoint are not part of the npm package contract.