README
¶
tooldiscovery
Discovery layer providing tool registry, search strategies, and progressive documentation for the ApertureStack tool framework.
Installation
go get github.com/jonwraymond/tooldiscovery@latest
Packages
| Package | Purpose |
|---|---|
discovery |
Unified facade combining index, search, semantic, and tooldoc |
index |
Global registry, tool lookup, and search interface |
search |
BM25-based full-text search strategy |
semantic |
Embedding-based semantic search (optional) |
tooldoc |
Progressive documentation with detail levels |
registry |
MCP server helper with local + backend execution |
Quick Start (Discovery Facade)
import (
"context"
"github.com/jonwraymond/tooldiscovery/discovery"
)
disc, _ := discovery.New(discovery.Options{})
_ = disc.RegisterTool(tool, backend)
results, _ := disc.Search(context.Background(), "create issue", 5)
for _, r := range results {
fmt.Printf("[%s] %s\n", r.ScoreType, r.Summary.ID)
}
Documentation
- MkDocs site: https://jonwraymond.github.io/tooldiscovery/
- Schemas and contracts:
docs/schemas.md - Architecture:
docs/architecture.md - Examples:
docs/examples.md - Registry:
docs/registry.md
Examples
Run the examples from the repo root:
go run ./examples/basic
go run ./examples/semantic
go run ./examples/hybrid
go run ./examples/full
License
MIT License - see LICENSE
Directories
¶
| Path | Synopsis |
|---|---|
|
Package discovery provides a unified facade for tool discovery operations.
|
Package discovery provides a unified facade for tool discovery operations. |
|
examples
|
|
|
basic
command
Package main demonstrates basic tool discovery with BM25 search.
|
Package main demonstrates basic tool discovery with BM25 search. |
|
full
command
Package main demonstrates the complete Discovery facade workflow.
|
Package main demonstrates the complete Discovery facade workflow. |
|
hybrid
command
Package main demonstrates hybrid search combining BM25 and semantic search.
|
Package main demonstrates hybrid search combining BM25 and semantic search. |
|
semantic
command
Package main demonstrates semantic search with embeddings.
|
Package main demonstrates semantic search with embeddings. |
|
Package index provides a global registry and search layer for tools.
|
Package index provides a global registry and search layer for tools. |
|
Package registry provides high-level helpers for building MCP servers with tool discovery, registration, and execution.
|
Package registry provides high-level helpers for building MCP servers with tool discovery, registration, and execution. |
|
Package search provides BM25-based search for the index package.
|
Package search provides BM25-based search for the index package. |
|
Package semantic provides semantic indexing and search for tool discovery.
|
Package semantic provides semantic indexing and search for tool discovery. |
|
Package tooldoc provides progressive, rich documentation for tools defined in the model package and indexed by the index package.
|
Package tooldoc provides progressive, rich documentation for tools defined in the model package and indexed by the index package. |
Click to show internal directories.
Click to hide internal directories.