Rene Nochebuena
850b63607c
Minor to v1.1.0. Make the whole environment-variable surface derive from the
indexed component-config tags instead of a hand-maintained list that drifts.
Also folds in the scaffold-symbol fixes staged as v1.0.1 (never tagged); the
generated scaffold compiles clean against einherjar v1.0.0.
internal/envspec (new):
- Parse index struct tags into env vars {name, module, struct, field, required,
default}. One source of truth: ParseTag, ForModule, FindStruct, All, KnownNames.
internal/tools:
- get_config_env: list the real env vars a component config reads (or all).
- check_env: flag unknown EINHERJAR_* names, required vars missing for the
composed modules, and dead vars (set for an uncomposed module).
- get_scaffold: .env.example is now DERIVED from the index — required vars
uncommented with a dev value, defaulted vars commented with their default.
The scaffold now composes logz.Config (Log logz.Config) so EINHERJAR_LOG_*
are live and documented, not hardcoded/ignored (log format is env-driven).
- validate_snippet: inject the real env-var name set into the rules package.
internal/index/builtins (wire conventions):
- Route the incremental "compose a component later" flow to get_config_env /
check_env; distinguish framework EINHERJAR_* from app-owned APP_* (JWT).
- Compose logz.Config in the config + Run() examples, to match the scaffold.
internal/rules:
- config.unknown-env-var (twelfth rule): reject an env:"EINHERJAR_*" struct tag
the framework doesn't declare. No-op until the server injects the name set, so
it never fires on incomplete knowledge.
Fixed (was v1.0.1): scaffold health hook + wire builtin used logz.Logger (real:
contracts/logging.Logger) and postgres.Component (hooks take Provider); env tags
were EINHERJAR_SERVER_ADDR / EINHERJAR_PG_DATABASE (real: _HOST/_PORT / _PG_NAME).
Tests: envspec unit tests; env tools against the real data/index.json; the rule.
Verified by generating the scaffold, building it against local einherjar v1.0.0
(exit 0), and runtime-loading the composed logz.Config (EINHERJAR_LOG_LEVEL=DEBUG
-> slog.LevelDebug, EINHERJAR_LOG_JSON=true). Version bumped to v1.1.0 (badge +
serverVersion). No dependency changes.
Reviewed-on: #3
Co-authored-by: Rene Nochebuena Guerrero <rene@nochebuena.dev>
Co-committed-by: Rene Nochebuena Guerrero <rene@nochebuena.dev>
52 lines
1.5 KiB
Go
52 lines
1.5 KiB
Go
// Package tools wires Einherjar MCP tools to a server. Each tool lives in its
|
|
// own file alongside its input and output types.
|
|
package tools
|
|
|
|
import (
|
|
"encoding/json"
|
|
|
|
"code.nochebuena.dev/einherjar/mcp/internal/index"
|
|
"github.com/modelcontextprotocol/go-sdk/mcp"
|
|
)
|
|
|
|
// Register binds every tool implemented in this package to s, sharing the
|
|
// provided index as their backing knowledge.
|
|
func Register(s *mcp.Server, idx *index.Index) {
|
|
registerListModules(s, idx)
|
|
registerGetModule(s, idx)
|
|
registerSearchSymbols(s, idx)
|
|
registerGetSymbol(s, idx)
|
|
registerListADRs(s, idx)
|
|
registerGetADR(s, idx)
|
|
registerGetExample(s, idx)
|
|
registerGetScaffold(s, idx)
|
|
registerGetConfigEnv(s, idx)
|
|
registerCheckEnv(s, idx)
|
|
registerValidateSnippet(s, idx)
|
|
registerGetCompliance(s, idx)
|
|
registerGetChangelog(s, idx)
|
|
}
|
|
|
|
// jsonText returns a CallToolResult whose single text block is the JSON
|
|
// encoding of v. The same value is also returned as the structured output,
|
|
// so hosts that surface structured outputs get a typed payload.
|
|
func jsonText(v any) *mcp.CallToolResult {
|
|
b, err := json.MarshalIndent(v, "", " ")
|
|
if err != nil {
|
|
return &mcp.CallToolResult{
|
|
IsError: true,
|
|
Content: []mcp.Content{&mcp.TextContent{Text: "encode error: " + err.Error()}},
|
|
}
|
|
}
|
|
return &mcp.CallToolResult{
|
|
Content: []mcp.Content{&mcp.TextContent{Text: string(b)}},
|
|
}
|
|
}
|
|
|
|
func errorResult(msg string) *mcp.CallToolResult {
|
|
return &mcp.CallToolResult{
|
|
IsError: true,
|
|
Content: []mcp.Content{&mcp.TextContent{Text: msg}},
|
|
}
|
|
}
|