Documentation
¶
Overview ¶
Package agentkb is the embedded knowledge base that briefs AI coding agents building PromptArena kits. Concepts are the single hand-authored source; the skill, schema, and catalog accessors are layered on top.
Index ¶
- func AgentsBrief() []byte
- func AuthoringPackYAML() []byte
- func GenerateConfigFieldsReference() ([]byte, error)
- func GenerateEvalsReference() ([]byte, error)
- func Reference(name string) ([]byte, error)
- func ReferenceNames() ([]string, error)
- func RenderExample(loader ExampleLoader, name string) (string, error)
- func Schema(name string) ([]byte, error)
- func SchemaNames() ([]string, error)
- func Skill() ([]byte, error)
- type Catalog
- type CatalogEntry
- type Concept
- type ExampleLoader
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AgentsBrief ¶
func AgentsBrief() []byte
AgentsBrief returns the cross-agent AGENTS.md shim written into a scaffolded project. The marker comment lets init detect a prior brief and avoid duplicating.
func AuthoringPackYAML ¶
func AuthoringPackYAML() []byte
AuthoringPackYAML returns the full authoring-agent PromptConfig YAML with AgentsBrief() embedded as the system_template block scalar.
func GenerateConfigFieldsReference ¶
GenerateConfigFieldsReference renders a compact per-kind field cheat-sheet from the embedded JSON schemas. It is a navigation aid; `promptarena schema <type>` remains the authoritative full schema.
func GenerateEvalsReference ¶
GenerateEvalsReference renders the unified eval/assertion catalog markdown from the live handler registry + evalmeta.yaml + the alias table.
func ReferenceNames ¶
ReferenceNames lists the bundled reference doc filenames (sorted).
func RenderExample ¶
func RenderExample(loader ExampleLoader, name string) (string, error)
RenderExample resolves a catalog entry by name and renders its files as text. Builtin sources resolve offline via the loader. It is the single definition shared by the `examples show` command and the MCP show_example tool.
func SchemaNames ¶
SchemaNames lists the top-level config schema type names (sorted), excluding the common/ $ref directory.
Types ¶
type Catalog ¶
type Catalog struct {
Entries []CatalogEntry `yaml:"entries"`
}
Catalog is the embedded example index.
func LoadCatalog ¶
LoadCatalog parses the embedded catalog.yaml.
type CatalogEntry ¶
type CatalogEntry struct {
Name string `yaml:"name" json:"name"`
Description string `yaml:"description" json:"description"`
Source string `yaml:"source" json:"source"` // "builtin:<name>" or "remote:<ref>"
Concepts []string `yaml:"concepts" json:"concepts"`
Tags []string `yaml:"tags" json:"tags"`
}
CatalogEntry indexes one example/template the agent can discover.
type Concept ¶
Concept is one authoring idiom parsed from concepts/<id>.md.
func ConceptByID ¶
ConceptByID returns a single concept by ID.
Source Files