@codesoul-co/hypha-skills / index

• Package index: @codesoul-co/hypha-skills
• Source: packages/skills/src/index.ts
• Exports: 42

Using this module

Aggregates the public entrypoint exports for @codesoul-co/hypha-skills; applications import these symbols from the package entrypoint instead of internal file paths.

Import from the package entrypoint

import {
  DefaultSkillPolicy,
  LocalSkillLoader,
  SkillContextLoader,
  SkillRegistry,
  SkillResolver,
  SkillSelector,
  skillActivationPolicySchema,
  skillAssetRefSchema,
} from '@codesoul-co/hypha-skills';

import type {
  AgentCapabilityConstraint,
  EffectiveAgentCapabilitySnapshotInput,
  LoadedSkillAsset,
  LoadedSkillContext,
  LocalSkillLoaderOptions,
  ParsedSkillMarkdown,
  ResolvedSkill,
  SkillActivationPolicy,
} from '@codesoul-co/hypha-skills';

// The complete export list is documented below.

Usage patterns

• Use the 21 type/interface exports as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.
• The module exposes 6 classes as constructable runtime implementations. Each symbol entry lists its constructor and public methods.
• The module exposes 6 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.
• The 9 constant/enum exports provide stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.

Runtime validation example

import { skillActivationPolicySchema } from '@codesoul-co/hypha-skills';

declare function loadExternalInput(): unknown;
const input: unknown = loadExternalInput();
const parsed = skillActivationPolicySchema.parse(input);

Parse untrusted configuration, network, or persisted input with the runtime schema before passing it to functions or classes that expect a validated contract.

Public exports

Symbol	Kind	Signature	Description
DefaultSkillPolicy	class	new DefaultSkillPolicy(options?: { allowedTrustLevels?: Array<NonNullable<SkillSpec["trustLevel"]>>; requireRegisteredTools?: boolean; }): DefaultSkillPolicy	Default Skill Policy class with 2 public constructor or member entries; its exact declarations are listed below.
LocalSkillLoader	class	new LocalSkillLoader(options: LocalSkillLoaderOptions): LocalSkillLoader	Local Skill Loader class with 3 public constructor or member entries; its exact declarations are listed below.
SkillContextLoader	class	new SkillContextLoader(options?: { defaultMaxChars?: number; maxReferences?: number; maxFileBytes?: number; readTimeoutMs?: number; }): SkillContextLoader	Skill Context Loader class with 2 public constructor or member entries; its exact declarations are listed below.
SkillRegistry	class	new SkillRegistry(): SkillRegistry	Skill Registry class with 5 public constructor or member entries; its exact declarations are listed below.
SkillResolver	class	new SkillResolver(registry: SkillRegistry): SkillResolver	Skill Resolver class with 2 public constructor or member entries; its exact declarations are listed below.
SkillSelector	class	new SkillSelector(registry: SkillRegistry): SkillSelector	Skill Selector class with 2 public constructor or member entries; its exact declarations are listed below.
skillActivationPolicySchema	constant	const skillActivationPolicySchema: z.ZodObject<{ mode: z.ZodEnum<["always", "keyword", "regex", "intent", "manual"]>; patterns: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; }, "strip", z.ZodTypeAny, { mode: "always" | "keyword" | "regex" | "intent" | "manual"; patterns?: string[] | undefined; }, { mode: "always" | "keyword" | "regex" | "intent" | "manual"; patterns?: string[] | undefined; }>	Runtime schema for Skill Activation Policy.
skillAssetRefSchema	constant	const skillAssetRefSchema: z.ZodObject<{ path: z.ZodString; type: z.ZodEnum<["reference", "script", "asset"]>; loadPolicy: z.ZodOptional<z.ZodEnum<["frontmatter_only", "on_activation", "never"]>>; }, "strip", z.ZodTypeAny, { path: string; type: "reference" | "script" | "asset"; loadPolicy?: "never" | "frontmatter_only" | "on_activation" | undefined; }, { path: string; type: "reference" | "script" | "asset"; loadPo...	Runtime schema for Skill Asset Ref.
skillRefSchema	constant	const skillRefSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { id: string; version?: string | undefined; }, { id: string; version?: string | undefined; }>	Runtime schema for Skill Ref.
skillSpecDefinition	constant	const skillSpecDefinition: SpecSchemaDefinition<SkillSpec>	Runtime validation entrypoint for the Skill spec, combining its parser, example and JSON Schema.
skillSpecDefinitions	constant	const skillSpecDefinitions: readonly [SpecSchemaDefinition<SkillSpec>]	Skill Spec Definitions constant exported by the index module.
skillSpecExample	constant	const skillSpecExample: SkillSpec	Valid example value for Skill Spec.
skillSpecJsonSchema	constant	const skillSpecJsonSchema: JsonSchema	JSON Schema for Skill Spec.
skillSpecJsonSchemas	constant	const skillSpecJsonSchemas: Record<string, JsonSchema>	Skill Spec JSON Schemas constant exported by the index module.
skillSpecSchema	constant	const skillSpecSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodString; name: z.ZodOptional<z.ZodString>; owner: z.ZodOptional<z.ZodString>; tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; createdAt: z.ZodOptional<z.ZodString>; updatedAt: z.ZodOptional<z.ZodString>; } & { description: z.ZodString; enabled: z.ZodOptional<z.ZodBoolean>; priority: z.ZodOptional<z.ZodNumber>; activationPolicy: z.ZodOptional<...	Runtime schema for Skill Spec.
createEffectiveAgentCapabilitySnapshot	function	createEffectiveAgentCapabilitySnapshot(input: EffectiveAgentCapabilitySnapshotInput): Readonly<EffectiveAgentCapabilitySnapshot>	Create Effective Agent Capability Snapshot function with 1 public call signature; parameters and return types are listed below.
listLocalSkillFiles	function	listLocalSkillFiles(directory: string, recursive?: boolean): Promise<string[]>	List Local Skill Files function with 1 public call signature; parameters and return types are listed below.
loadSkillMarkdownFile	function	loadSkillMarkdownFile(filePath: string): Promise<ParsedSkillMarkdown>	Load Skill Markdown File function with 1 public call signature; parameters and return types are listed below.
parseSkillMarkdown	function	parseSkillMarkdown(raw: string, filePath: string): ParsedSkillMarkdown	Parse Skill Markdown function with 1 public call signature; parameters and return types are listed below.
resolveBuiltinSkillsDirectory	function	resolveBuiltinSkillsDirectory(): string	Resolves the directory that ships Hypha's built-in skills (context-enrichment, intent-classification) inside this npm package. The published tarball includes builtins/ next to dist/, so consumers can load the framework built-ins without a source checkout of the Server.
validateSkillSpec	function	validateSkillSpec(input: unknown): SkillSpec	Validate Skill Spec function with 1 public call signature; parameters and return types are listed below.
AgentCapabilityConstraint	interface	interface AgentCapabilityConstraint	Agent Capability Constraint interface with 6 public fields or methods.
EffectiveAgentCapabilitySnapshotInput	interface	interface EffectiveAgentCapabilitySnapshotInput	Effective Agent Capability Snapshot Input interface with 10 public fields or methods.
LoadedSkillAsset	interface	interface LoadedSkillAsset extends SkillAssetRef	Loaded Skill Asset interface with 6 public fields or methods.
LoadedSkillContext	interface	interface LoadedSkillContext	Loaded Skill Context interface with 16 public fields or methods.
LocalSkillLoaderOptions	interface	interface LocalSkillLoaderOptions	Local Skill Loader Options interface with 3 public fields or methods.
ParsedSkillMarkdown	interface	interface ParsedSkillMarkdown	Parsed Skill Markdown interface with 3 public fields or methods.
ResolvedSkill	interface	interface ResolvedSkill	Resolved Skill interface with 3 public fields or methods.
SkillActivationPolicy	interface	interface SkillActivationPolicy	Skill Activation Policy interface with 2 public fields or methods.
SkillAssetRef	interface	interface SkillAssetRef	Skill Asset Ref interface with 3 public fields or methods.
SkillContextLoadInput	interface	interface SkillContextLoadInput	Skill Context Load Input interface with 3 public fields or methods.
SkillLoader	interface	interface SkillLoader	Skill Loader interface with 1 public fields or methods.
SkillPolicy	interface	interface SkillPolicy	Skill Policy interface with 1 public fields or methods.
SkillPolicyDecision	interface	interface SkillPolicyDecision	Skill Policy Decision interface with 6 public fields or methods.
SkillPolicyInput	interface	interface SkillPolicyInput	Skill Policy Input interface with 2 public fields or methods.
SkillRef	interface	interface SkillRef	Skill Ref interface with 2 public fields or methods.
SkillResolutionContext	interface	interface SkillResolutionContext	Skill Resolution Context interface with 8 public fields or methods.
SkillSelection	interface	interface SkillSelection	Skill Selection interface with 4 public fields or methods.
SkillSelectionRejection	interface	interface SkillSelectionRejection	Skill Selection Rejection interface with 2 public fields or methods.
SkillSelectionResult	interface	interface SkillSelectionResult	Skill Selection Result interface with 2 public fields or methods.
SkillSpec	interface	interface SkillSpec extends VersionedSpec, SpecMetadata	Skill Spec interface with 26 public fields or methods.
SkillActivationMode	type	type SkillActivationMode = 'always' | 'keyword' | 'regex' | 'intent' | 'manual'	Public type alias for Skill Activation Mode; the declaration contains its complete type expression.

DefaultSkillPolicy

Default Skill Policy class with 2 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { DefaultSkillPolicy } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export declare class DefaultSkillPolicy implements SkillPolicy {
    constructor(options?: {
            allowedTrustLevels?: Array<NonNullable<SkillSpec['trustLevel']>>;
            requireRegisteredTools?: boolean;
        });
    evaluate(input: SkillPolicyInput): Promise<SkillPolicyDecision>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(options?: { allowedTrustLevels?: Array<NonNullable<SkillSpec["trustLevel"]>>; requireRegisteredTools?: boolean; }): DefaultSkillPolicy	Creates an instance of this class.
evaluate	method	evaluate(input: SkillPolicyInput): Promise<SkillPolicyDecision>	Public method; parameters and return type are shown in the signature.

LocalSkillLoader

Local Skill Loader class with 3 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { LocalSkillLoader } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export declare class LocalSkillLoader implements SkillLoader {
    constructor(options: LocalSkillLoaderOptions);
    load(): Promise<SkillSpec[]>;
    loadInto(registry: SkillRegistry): Promise<SkillSpec[]>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(options: LocalSkillLoaderOptions): LocalSkillLoader	Creates an instance of this class.
load	method	load(): Promise<SkillSpec[]>	Public method; parameters and return type are shown in the signature.
loadInto	method	loadInto(registry: SkillRegistry): Promise<SkillSpec[]>	Public method; parameters and return type are shown in the signature.

SkillContextLoader

Skill Context Loader class with 2 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { SkillContextLoader } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export declare class SkillContextLoader {
    constructor(options?: {
            defaultMaxChars?: number;
            maxReferences?: number;
            maxFileBytes?: number;
            readTimeoutMs?: number;
        });
    load(input: SkillContextLoadInput): Promise<LoadedSkillContext>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(options?: { defaultMaxChars?: number; maxReferences?: number; maxFileBytes?: number; readTimeoutMs?: number; }): SkillContextLoader	Creates an instance of this class.
load	method	load(input: SkillContextLoadInput): Promise<LoadedSkillContext>	Public method; parameters and return type are shown in the signature.

SkillRegistry

Skill Registry class with 5 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { SkillRegistry } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export declare class SkillRegistry {
    register(skill: SkillSpec): void;
    registerMany(skills: SkillSpec[]): void;
    get(skillId: string): SkillSpec | null;
    list(): SkillSpec[];
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(): SkillRegistry	Creates an instance of this class.
get	method	get(skillId: string): SkillSpec | null	Public method; parameters and return type are shown in the signature.
list	method	list(): SkillSpec[]	Public method; parameters and return type are shown in the signature.
register	method	register(skill: SkillSpec): void	Public method; parameters and return type are shown in the signature.
registerMany	method	registerMany(skills: SkillSpec[]): void	Public method; parameters and return type are shown in the signature.

SkillResolver

Skill Resolver class with 2 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { SkillResolver } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export declare class SkillResolver {
    constructor(registry: SkillRegistry);
    resolve(context: SkillResolutionContext): ResolvedSkill[];
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(registry: SkillRegistry): SkillResolver	Creates an instance of this class.
resolve	method	resolve(context: SkillResolutionContext): ResolvedSkill[]	Public method; parameters and return type are shown in the signature.

SkillSelector

Skill Selector class with 2 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { SkillSelector } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export declare class SkillSelector {
    constructor(registry: SkillRegistry);
    select(context: SkillResolutionContext): SkillSelectionResult;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(registry: SkillRegistry): SkillSelector	Creates an instance of this class.
select	method	select(context: SkillResolutionContext): SkillSelectionResult	Public method; parameters and return type are shown in the signature.

skillActivationPolicySchema

Runtime schema for Skill Activation Policy.

• Kind: constant
• Import: import { skillActivationPolicySchema } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export declare const skillActivationPolicySchema: z.ZodObject<{ mode: z.ZodEnum<["always", "keyword", "regex", "intent", "manual"]>; patterns: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; }, "strip", z.ZodTypeAny, { mode: "always" | "keyword" | "regex" | "intent" | "manual"; patterns?: string[] | undefined; }, { mode: "always" | "keyword" | "regex" | "intent" | "manual"; patterns?: string[] | undefined; }>;

skillAssetRefSchema

Runtime schema for Skill Asset Ref.

• Kind: constant
• Import: import { skillAssetRefSchema } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export declare const skillAssetRefSchema: z.ZodObject<{ path: z.ZodString; type: z.ZodEnum<["reference", "script", "asset"]>; loadPolicy: z.ZodOptional<z.ZodEnum<["frontmatter_only", "on_activation", "never"]>>; }, "strip", z.ZodTypeAny, { path: string; type: "reference" | "script" | "asset"; loadPolicy?: "never" | "frontmatter_only" | "on_activation" | undefined; }, { path: string; type: "reference" | "script" | "asset"; loadPolicy?: "never" | "frontmatter_only" | "on_activation" | undefined; }>;

skillRefSchema

Runtime schema for Skill Ref.

• Kind: constant
• Import: import { skillRefSchema } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export declare const skillRefSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { id: string; version?: string | undefined; }, { id: string; version?: string | undefined; }>;

skillSpecDefinition

Runtime validation entrypoint for the Skill spec, combining its parser, example and JSON Schema.

• Kind: constant
• Import: import { skillSpecDefinition } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export declare const skillSpecDefinition: SpecSchemaDefinition<SkillSpec>;

skillSpecDefinitions

Skill Spec Definitions constant exported by the index module.

• Kind: constant
• Import: import { skillSpecDefinitions } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export declare const skillSpecDefinitions: readonly [SpecSchemaDefinition<SkillSpec>];

skillSpecExample

Valid example value for Skill Spec.

• Kind: constant
• Import: import { skillSpecExample } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export declare const skillSpecExample: SkillSpec;

skillSpecJsonSchema

JSON Schema for Skill Spec.

• Kind: constant
• Import: import { skillSpecJsonSchema } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export declare const skillSpecJsonSchema: JsonSchema;

skillSpecJsonSchemas

Skill Spec JSON Schemas constant exported by the index module.

• Kind: constant
• Import: import { skillSpecJsonSchemas } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export declare const skillSpecJsonSchemas: Record<string, JsonSchema>;

skillSpecSchema

Runtime schema for Skill Spec.

• Kind: constant
• Import: import { skillSpecSchema } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const skillSpecSchema: (typeof import('@codesoul-co/hypha-skills'))['skillSpecSchema'];

This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.

createEffectiveAgentCapabilitySnapshot

Create Effective Agent Capability Snapshot function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { createEffectiveAgentCapabilitySnapshot } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export declare function createEffectiveAgentCapabilitySnapshot(input: EffectiveAgentCapabilitySnapshotInput): Readonly<EffectiveAgentCapabilitySnapshot>;

Call signature

createEffectiveAgentCapabilitySnapshot(input: EffectiveAgentCapabilitySnapshotInput): Readonly<EffectiveAgentCapabilitySnapshot>

Parameters

Parameter	Type	Required	Description
input	EffectiveAgentCapabilitySnapshotInput	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: Readonly<EffectiveAgentCapabilitySnapshot>
• Description: The return contract is defined by the type shown above.

listLocalSkillFiles

List Local Skill Files function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { listLocalSkillFiles } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export declare function listLocalSkillFiles(directory: string, recursive?: boolean): Promise<string[]>;

Call signature

listLocalSkillFiles(directory: string, recursive?: boolean): Promise<string[]>

Parameters

Parameter	Type	Required	Description
directory	string	Yes	Required parameter; accepted values are defined by the type column.
recursive	boolean	No	Optional parameter; accepted values are defined by the type column.

Returns

• Type: Promise<string[]>
• Description: The return contract is defined by the type shown above.

loadSkillMarkdownFile

Load Skill Markdown File function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { loadSkillMarkdownFile } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export declare function loadSkillMarkdownFile(filePath: string): Promise<ParsedSkillMarkdown>;

Call signature

loadSkillMarkdownFile(filePath: string): Promise<ParsedSkillMarkdown>

Parameters

Parameter	Type	Required	Description
filePath	string	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: Promise<ParsedSkillMarkdown>
• Description: The return contract is defined by the type shown above.

parseSkillMarkdown

Parse Skill Markdown function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { parseSkillMarkdown } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export declare function parseSkillMarkdown(raw: string, filePath: string): ParsedSkillMarkdown;

Call signature

parseSkillMarkdown(raw: string, filePath: string): ParsedSkillMarkdown

Parameters

Parameter	Type	Required	Description
raw	string	Yes	Required parameter; accepted values are defined by the type column.
filePath	string	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: ParsedSkillMarkdown
• Description: The return contract is defined by the type shown above.

resolveBuiltinSkillsDirectory

Resolves the directory that ships Hypha's built-in skills (context-enrichment, intent-classification) inside this npm package. The published tarball includes builtins/ next to dist/, so consumers can load the framework built-ins without a source checkout of the Server.

• Kind: function
• Import: import { resolveBuiltinSkillsDirectory } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export declare function resolveBuiltinSkillsDirectory(): string;

Call signature

resolveBuiltinSkillsDirectory(): string

Resolves the directory that ships Hypha's built-in skills (context-enrichment, intent-classification) inside this npm package. The published tarball includes builtins/ next to dist/, so consumers can load the framework built-ins without a source checkout of the Server.

Parameters

No parameters.

Returns

• Type: string
• Description: The return contract is defined by the type shown above.

validateSkillSpec

Validate Skill Spec function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateSkillSpec } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export declare function validateSkillSpec(input: unknown): SkillSpec;

Call signature

validateSkillSpec(input: unknown): SkillSpec

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: SkillSpec
• Description: The return contract is defined by the type shown above.

AgentCapabilityConstraint

Agent Capability Constraint interface with 6 public fields or methods.

• Kind: interface
• Import: import type { AgentCapabilityConstraint } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export interface AgentCapabilityConstraint {
    allowedToolIds?: string[];
    allowedMCPServerIds?: string[];
    memoryAccess?: EffectiveAgentCapabilitySnapshot['memoryAccess'];
    allowedExecutionProfiles?: string[];
    maximumSideEffectLevel?: SideEffectLevel;
    policyRefs?: string[];
}

Contract members

Member	Kind	Signature	Description
allowedExecutionProfiles	property	allowedExecutionProfiles?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
allowedMCPServerIds	property	allowedMCPServerIds?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
allowedToolIds	property	allowedToolIds?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
maximumSideEffectLevel	property	maximumSideEffectLevel?: SideEffectLevel	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryAccess	property	memoryAccess?: "none" | "read" | "write" | "read_write"	Public property; its type, readonly modifier and optionality are shown in the signature.
policyRefs	property	policyRefs?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.

EffectiveAgentCapabilitySnapshotInput

Effective Agent Capability Snapshot Input interface with 10 public fields or methods.

• Kind: interface
• Import: import type { EffectiveAgentCapabilitySnapshotInput } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export interface EffectiveAgentCapabilitySnapshotInput {
    runId: string;
    agentId: string;
    principalId: string;
    tenantId?: string;
    domainId?: string;
    createdAt?: string;
    expiresAt?: string;
    agent: AgentCapabilityConstraint;
    domain: AgentCapabilityConstraint;
    activeSkills: LoadedSkillContext[];
}

Contract members

Member	Kind	Signature	Description
activeSkills	property	activeSkills: LoadedSkillContext[]	Public property; its type, readonly modifier and optionality are shown in the signature.
agent	property	agent: AgentCapabilityConstraint	Public property; its type, readonly modifier and optionality are shown in the signature.
agentId	property	agentId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
createdAt	property	createdAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
domain	property	domain: AgentCapabilityConstraint	Public property; its type, readonly modifier and optionality are shown in the signature.
domainId	property	domainId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
expiresAt	property	expiresAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
principalId	property	principalId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
runId	property	runId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
tenantId	property	tenantId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.

LoadedSkillAsset

Loaded Skill Asset interface with 6 public fields or methods.

• Kind: interface
• Import: import type { LoadedSkillAsset } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export interface LoadedSkillAsset extends SkillAssetRef {
    absolutePath?: string;
    content?: string;
    truncated?: boolean;
}

Contract members

Member	Kind	Signature	Description
absolutePath	property	absolutePath?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
content	property	content?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
loadPolicy	property	loadPolicy?: "never" | "frontmatter_only" | "on_activation"	Public property; its type, readonly modifier and optionality are shown in the signature.
path	property	path: string	Public property; its type, readonly modifier and optionality are shown in the signature.
truncated	property	truncated?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
type	property	type: "reference" | "script" | "asset"	Public property; its type, readonly modifier and optionality are shown in the signature.

LoadedSkillContext

Loaded Skill Context interface with 16 public fields or methods.

• Kind: interface
• Import: import type { LoadedSkillContext } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export interface LoadedSkillContext {
    id: string;
    version: string;
    name?: string;
    description: string;
    instructions?: string;
    references: LoadedSkillAsset[];
    allowedTools: string[];
    requiredTools: string[];
    requiredMCPServers: string[];
    memoryAccessPolicy?: string;
    sideEffectPolicy?: string;
    trustLevel?: SkillSpec['trustLevel'];
    provenance?: Record<string, unknown>;
    policyDecision: SkillPolicyDecision;
    activation: {
        reason: string;
        matchedPatterns: string[];
    };
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
activation	property	activation: { reason: string; matchedPatterns: string[]; }	Public property; its type, readonly modifier and optionality are shown in the signature.
allowedTools	property	allowedTools: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
description	property	description: string	Public property; its type, readonly modifier and optionality are shown in the signature.
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
instructions	property	instructions?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryAccessPolicy	property	memoryAccessPolicy?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
name	property	name?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
policyDecision	property	policyDecision: SkillPolicyDecision	Public property; its type, readonly modifier and optionality are shown in the signature.
provenance	property	provenance?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
references	property	references: LoadedSkillAsset[]	Public property; its type, readonly modifier and optionality are shown in the signature.
requiredMCPServers	property	requiredMCPServers: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
requiredTools	property	requiredTools: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
sideEffectPolicy	property	sideEffectPolicy?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
trustLevel	property	trustLevel?: "trusted" | "reviewed" | "untrusted"	Public property; its type, readonly modifier and optionality are shown in the signature.
version	property	version: string	Public property; its type, readonly modifier and optionality are shown in the signature.

LocalSkillLoaderOptions

Local Skill Loader Options interface with 3 public fields or methods.

• Kind: interface
• Import: import type { LocalSkillLoaderOptions } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export interface LocalSkillLoaderOptions {
    directories: string[];
    recursive?: boolean;
    includeDisabled?: boolean;
}

Contract members

Member	Kind	Signature	Description
directories	property	directories: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
includeDisabled	property	includeDisabled?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
recursive	property	recursive?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.

ParsedSkillMarkdown

Parsed Skill Markdown interface with 3 public fields or methods.

• Kind: interface
• Import: import type { ParsedSkillMarkdown } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export interface ParsedSkillMarkdown {
    filePath: string;
    slug: string;
    spec: SkillSpec;
}

Contract members

Member	Kind	Signature	Description
filePath	property	filePath: string	Public property; its type, readonly modifier and optionality are shown in the signature.
slug	property	slug: string	Public property; its type, readonly modifier and optionality are shown in the signature.
spec	property	spec: SkillSpec	Public property; its type, readonly modifier and optionality are shown in the signature.

ResolvedSkill

Resolved Skill interface with 3 public fields or methods.

• Kind: interface
• Import: import type { ResolvedSkill } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export interface ResolvedSkill {
    spec: SkillSpec;
    loadedInstructions?: string;
    loadedReferences: SkillAssetRef[];
}

Contract members

Member	Kind	Signature	Description
loadedInstructions	property	loadedInstructions?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
loadedReferences	property	loadedReferences: SkillAssetRef[]	Public property; its type, readonly modifier and optionality are shown in the signature.
spec	property	spec: SkillSpec	Public property; its type, readonly modifier and optionality are shown in the signature.

SkillActivationPolicy

Skill Activation Policy interface with 2 public fields or methods.

• Kind: interface
• Import: import type { SkillActivationPolicy } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export interface SkillActivationPolicy {
    mode: SkillActivationMode;
    patterns?: string[];
}

Contract members

Member	Kind	Signature	Description
mode	property	mode: SkillActivationMode	Public property; its type, readonly modifier and optionality are shown in the signature.
patterns	property	patterns?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.

SkillAssetRef

Skill Asset Ref interface with 3 public fields or methods.

• Kind: interface
• Import: import type { SkillAssetRef } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export interface SkillAssetRef {
    path: string;
    type: 'reference' | 'script' | 'asset';
    loadPolicy?: 'frontmatter_only' | 'on_activation' | 'never';
}

Contract members

Member	Kind	Signature	Description
loadPolicy	property	loadPolicy?: "never" | "frontmatter_only" | "on_activation"	Public property; its type, readonly modifier and optionality are shown in the signature.
path	property	path: string	Public property; its type, readonly modifier and optionality are shown in the signature.
type	property	type: "reference" | "script" | "asset"	Public property; its type, readonly modifier and optionality are shown in the signature.

SkillContextLoadInput

Skill Context Load Input interface with 3 public fields or methods.

• Kind: interface
• Import: import type { SkillContextLoadInput } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export interface SkillContextLoadInput {
    selection: SkillSelection;
    policyDecision: SkillPolicyDecision;
    maxChars?: number;
}

Contract members

Member	Kind	Signature	Description
maxChars	property	maxChars?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
policyDecision	property	policyDecision: SkillPolicyDecision	Public property; its type, readonly modifier and optionality are shown in the signature.
selection	property	selection: SkillSelection	Public property; its type, readonly modifier and optionality are shown in the signature.

SkillLoader

Skill Loader interface with 1 public fields or methods.

• Kind: interface
• Import: import type { SkillLoader } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export interface SkillLoader {
    load(): Promise<SkillSpec[]>;
}

Contract members

Member	Kind	Signature	Description
load	method	load(): Promise<SkillSpec[]>	Public method; parameters and return type are shown in the signature.

SkillPolicy

Skill Policy interface with 1 public fields or methods.

• Kind: interface
• Import: import type { SkillPolicy } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export interface SkillPolicy {
    evaluate(input: SkillPolicyInput): Promise<SkillPolicyDecision>;
}

Contract members

Member	Kind	Signature	Description
evaluate	method	evaluate(input: SkillPolicyInput): Promise<SkillPolicyDecision>	Public method; parameters and return type are shown in the signature.

SkillPolicyDecision

Skill Policy Decision interface with 6 public fields or methods.

• Kind: interface
• Import: import type { SkillPolicyDecision } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export interface SkillPolicyDecision {
    allowed: boolean;
    reason?: string;
    requiresHumanReview?: boolean;
    allowedTools: string[];
    policyId?: string;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
allowed	property	allowed: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
allowedTools	property	allowedTools: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
policyId	property	policyId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
reason	property	reason?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
requiresHumanReview	property	requiresHumanReview?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.

SkillPolicyInput

Skill Policy Input interface with 2 public fields or methods.

• Kind: interface
• Import: import type { SkillPolicyInput } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export interface SkillPolicyInput {
    selection: SkillSelection;
    context: SkillResolutionContext;
}

Contract members

Member	Kind	Signature	Description
context	property	context: SkillResolutionContext	Public property; its type, readonly modifier and optionality are shown in the signature.
selection	property	selection: SkillSelection	Public property; its type, readonly modifier and optionality are shown in the signature.

SkillRef

Skill Ref interface with 2 public fields or methods.

• Kind: interface
• Import: import type { SkillRef } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export interface SkillRef {
    id: string;
    version?: string;
}

Contract members

Member	Kind	Signature	Description
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
version	property	version?: string	Public property; its type, readonly modifier and optionality are shown in the signature.

SkillResolutionContext

Skill Resolution Context interface with 8 public fields or methods.

• Kind: interface
• Import: import type { SkillResolutionContext } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export interface SkillResolutionContext {
    agentSkillRefs: SkillRef[];
    intent?: string;
    inputText?: string;
    allowedSkills?: string[];
    requiredSkills?: string[];
    manualSkillIds?: string[];
    availableToolRefs?: string[];
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
agentSkillRefs	property	agentSkillRefs: SkillRef[]	Public property; its type, readonly modifier and optionality are shown in the signature.
allowedSkills	property	allowedSkills?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
availableToolRefs	property	availableToolRefs?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
inputText	property	inputText?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
intent	property	intent?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
manualSkillIds	property	manualSkillIds?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
requiredSkills	property	requiredSkills?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.

SkillSelection

Skill Selection interface with 4 public fields or methods.

• Kind: interface
• Import: import type { SkillSelection } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export interface SkillSelection {
    spec: SkillSpec;
    reason: string;
    matchedPatterns: string[];
    priority: number;
}

Contract members

Member	Kind	Signature	Description
matchedPatterns	property	matchedPatterns: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
priority	property	priority: number	Public property; its type, readonly modifier and optionality are shown in the signature.
reason	property	reason: string	Public property; its type, readonly modifier and optionality are shown in the signature.
spec	property	spec: SkillSpec	Public property; its type, readonly modifier and optionality are shown in the signature.

SkillSelectionRejection

Skill Selection Rejection interface with 2 public fields or methods.

• Kind: interface
• Import: import type { SkillSelectionRejection } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export interface SkillSelectionRejection {
    skillId: string;
    reason: string;
}

Contract members

Member	Kind	Signature	Description
reason	property	reason: string	Public property; its type, readonly modifier and optionality are shown in the signature.
skillId	property	skillId: string	Public property; its type, readonly modifier and optionality are shown in the signature.

SkillSelectionResult

Skill Selection Result interface with 2 public fields or methods.

• Kind: interface
• Import: import type { SkillSelectionResult } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export interface SkillSelectionResult {
    selected: SkillSelection[];
    rejected: SkillSelectionRejection[];
}

Contract members

Member	Kind	Signature	Description
rejected	property	rejected: SkillSelectionRejection[]	Public property; its type, readonly modifier and optionality are shown in the signature.
selected	property	selected: SkillSelection[]	Public property; its type, readonly modifier and optionality are shown in the signature.

SkillSpec

Skill Spec interface with 26 public fields or methods.

• Kind: interface
• Import: import type { SkillSpec } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export interface SkillSpec extends VersionedSpec, SpecMetadata {
    id: string;
    version: string;
    name?: string;
    description: string;
    enabled?: boolean;
    priority?: number;
    activationPolicy?: SkillActivationPolicy;
    instructions?: string;
    references?: SkillAssetRef[];
    scripts?: SkillAssetRef[];
    assets?: SkillAssetRef[];
    allowedTools?: string[];
    requiredTools?: string[];
    requiredMCPServers?: string[];
    memoryAccessPolicy?: string;
    sideEffectPolicy?: string;
    contextBudget?: number;
    inputSchema?: JsonSchema;
    outputContract?: JsonSchema;
    evaluationCases?: string[];
    provenance?: Record<string, unknown>;
    trustLevel?: 'trusted' | 'reviewed' | 'untrusted';
}

Contract members

Member	Kind	Signature	Description
activationPolicy	property	activationPolicy?: SkillActivationPolicy	Public property; its type, readonly modifier and optionality are shown in the signature.
allowedTools	property	allowedTools?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
assets	property	assets?: SkillAssetRef[]	Public property; its type, readonly modifier and optionality are shown in the signature.
contextBudget	property	contextBudget?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
createdAt	property	createdAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
description	property	description: string	Public property; its type, readonly modifier and optionality are shown in the signature.
enabled	property	enabled?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
evaluationCases	property	evaluationCases?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
inputSchema	property	inputSchema?: JsonSchema	Public property; its type, readonly modifier and optionality are shown in the signature.
instructions	property	instructions?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryAccessPolicy	property	memoryAccessPolicy?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
name	property	name?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
outputContract	property	outputContract?: JsonSchema	Public property; its type, readonly modifier and optionality are shown in the signature.
owner	property	owner?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
priority	property	priority?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
provenance	property	provenance?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
references	property	references?: SkillAssetRef[]	Public property; its type, readonly modifier and optionality are shown in the signature.
requiredMCPServers	property	requiredMCPServers?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
requiredTools	property	requiredTools?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
scripts	property	scripts?: SkillAssetRef[]	Public property; its type, readonly modifier and optionality are shown in the signature.
sideEffectPolicy	property	sideEffectPolicy?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
tags	property	tags?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
trustLevel	property	trustLevel?: "trusted" | "reviewed" | "untrusted"	Public property; its type, readonly modifier and optionality are shown in the signature.
updatedAt	property	updatedAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
version	property	version: string	Public property; its type, readonly modifier and optionality are shown in the signature.

SkillActivationMode

Public type alias for Skill Activation Mode; the declaration contains its complete type expression.

• Kind: type
• Import: import type { SkillActivationMode } from '@codesoul-co/hypha-skills';
• Source module: index

Declaration

export type SkillActivationMode = 'always' | 'keyword' | 'regex' | 'intent' | 'manual';