📚 Package Specification Audit Report
Date: 2026-08-09
Total Packages: 34
Packages with Specs: 34
Coverage: 100%
Coverage Summary
All 34 packages under pkg/ have a README.md. No missing specifications.
Note: the git history available in this checkout is shallow/squashed (single commit), so file-modification-time based staleness detection was not reliable and is not reported here. Staleness was instead assessed via direct symbol-diffing between source and spec (see below).
🚨 Missing Specifications
None. All 34 packages have specifications.
🔄 Documentation Accuracy Issues
View accuracy issues (5 packages affected)
❌ cli — Phantom (nonexistent) documented function
- Spec claims:
pkg/cli/README.md documents func FindOrFetchModelPricing(ctx context.Context, provider, model string) (map[string]float64, bool) in model_costs.go.
- Actual source:
pkg/cli/model_costs.go only defines an unexported func findModelPricing(provider, model string) (map[string]float64, bool) — no FindOrFetchModelPricing, no context.Context parameter, and no fetch behavior exists.
- Recommendation: Either rename/export the real function to match the spec, or correct the spec entry to reference
findModelPricing (and remove the ctx parameter and "fetch" wording) — re-run spec-extractor for pkg/cli.
⚠️ cli — 17 undocumented exported symbols
New/changed exported symbols not mentioned in pkg/cli/README.md, including: AnalysisBase, AuditData, CrossRunAuditReport, DiffEntryBase, FirewallSummaryBase, MergeWorkflowContent, MetricEvalResults, RemoveTopLevelFieldFromFrontmatter, RunActionlintOnFiles, RunAddInteractive, SetupAuthResult, SetupRepositoryCheckResult, SkillActivation, SyftScanResult, TokenCoreMetrics, UpgradeConfig, WorkflowTrialResult.
- Recommendation: Re-run spec-extractor for
pkg/cli to add coverage for these symbols.
⚠️ workflow — 23 undocumented exported symbols
Includes (verified to exist in source, e.g. pkg/workflow/awf_config.go, pkg/workflow/tools_types.go): AWFBoundedQueriesConfig, AWFBoundedQueryPrivateRepo, AiCreditsPricingConfig, BoundedQueriesConfig, BoundedQueryPrivateRepo, BoundedQueryRuntime, BuildEngineSecretValidationStep, ContainerPinTarget, EngineNetworkDefinition, EngineSecretValidationConfig, EnginesWithCapability, GetMCPConfigAdapterFilename, GetMCPConfigAdapterWriteStep, HarnessRunner, HasBashExplicitRestriction, InferenceProviderResolver, InlineEngineDriver, IsActionFailureIssueExpiresExplicit, MCPConfigAdapterProvider, MCPProxyEngine, NPMInstallOptions, OTLPWorkloadIdentityConfig, SafeOutputAllowedLabelsConfig.
- Recommendation: Re-run spec-extractor for
pkg/workflow (largest package, 470 source files) to close this documentation gap.
⚠️ parser — 4 undocumented exported symbols
IsAnyGitHubHostEnvVarSet, IsGitHubHost, IsImportSafeSharedWorkflowOn, MCPRootInfo exist in source but are not referenced in pkg/parser/README.md.
- Recommendation: Re-run spec-extractor for
pkg/parser.
⚠️ agentdrain — 5 undocumented exported symbols
(*Coordinator).AllClusters, (*Miner).Clusters, (*Coordinator).LoadWeightsJSON, (*Coordinator).SaveSnapshots, (*Coordinator).SaveWeightsJSON exist in pkg/agentdrain/coordinator.go and pkg/agentdrain/miner.go but are not documented.
- Recommendation: Re-run spec-extractor for
pkg/agentdrain.
📊 Quality Scores (spot-checked packages)
| Package |
Completeness |
Accuracy |
Overall |
cli |
96% (17/522 exported symbols undocumented) |
⚠️ Has 1 phantom function |
⚠️ Needs Attention |
workflow |
97% (23/920 exported symbols undocumented) |
✅ No phantoms found |
⚠️ Needs Attention |
parser |
97% (4/124 exported symbols undocumented) |
✅ No phantoms found |
✅ Good |
agentdrain |
85% (5/34 exported symbols undocumented) |
✅ No phantoms found |
⚠️ Needs Attention |
| All other 30 packages |
100% (spot-checked, no gaps found) |
✅ |
✅ Good |
Action Items
📚 Next review scheduled for tomorrow. Close this issue once all items are resolved.
📚 Specification review by Package Specification Librarian · auto · 72.8 AIC · ⌖ 2.47 AIC · ⊞ 8.5K · ◷
📚 Package Specification Audit Report
Date: 2026-08-09
Total Packages: 34
Packages with Specs: 34
Coverage: 100%
Coverage Summary
All 34 packages under
pkg/have aREADME.md. No missing specifications.Note: the git history available in this checkout is shallow/squashed (single commit), so file-modification-time based staleness detection was not reliable and is not reported here. Staleness was instead assessed via direct symbol-diffing between source and spec (see below).
🚨 Missing Specifications
None. All 34 packages have specifications.
🔄 Documentation Accuracy Issues
View accuracy issues (5 packages affected)
❌
cli— Phantom (nonexistent) documented functionpkg/cli/README.mddocumentsfunc FindOrFetchModelPricing(ctx context.Context, provider, model string) (map[string]float64, bool)inmodel_costs.go.pkg/cli/model_costs.goonly defines an unexportedfunc findModelPricing(provider, model string) (map[string]float64, bool)— noFindOrFetchModelPricing, nocontext.Contextparameter, and no fetch behavior exists.findModelPricing(and remove thectxparameter and "fetch" wording) — re-run spec-extractor forpkg/cli.cli— 17 undocumented exported symbolsNew/changed exported symbols not mentioned in
pkg/cli/README.md, including:AnalysisBase,AuditData,CrossRunAuditReport,DiffEntryBase,FirewallSummaryBase,MergeWorkflowContent,MetricEvalResults,RemoveTopLevelFieldFromFrontmatter,RunActionlintOnFiles,RunAddInteractive,SetupAuthResult,SetupRepositoryCheckResult,SkillActivation,SyftScanResult,TokenCoreMetrics,UpgradeConfig,WorkflowTrialResult.pkg/clito add coverage for these symbols.workflow— 23 undocumented exported symbolsIncludes (verified to exist in source, e.g.
pkg/workflow/awf_config.go,pkg/workflow/tools_types.go):AWFBoundedQueriesConfig,AWFBoundedQueryPrivateRepo,AiCreditsPricingConfig,BoundedQueriesConfig,BoundedQueryPrivateRepo,BoundedQueryRuntime,BuildEngineSecretValidationStep,ContainerPinTarget,EngineNetworkDefinition,EngineSecretValidationConfig,EnginesWithCapability,GetMCPConfigAdapterFilename,GetMCPConfigAdapterWriteStep,HarnessRunner,HasBashExplicitRestriction,InferenceProviderResolver,InlineEngineDriver,IsActionFailureIssueExpiresExplicit,MCPConfigAdapterProvider,MCPProxyEngine,NPMInstallOptions,OTLPWorkloadIdentityConfig,SafeOutputAllowedLabelsConfig.pkg/workflow(largest package, 470 source files) to close this documentation gap.parser— 4 undocumented exported symbolsIsAnyGitHubHostEnvVarSet,IsGitHubHost,IsImportSafeSharedWorkflowOn,MCPRootInfoexist in source but are not referenced inpkg/parser/README.md.pkg/parser.agentdrain— 5 undocumented exported symbols(*Coordinator).AllClusters,(*Miner).Clusters,(*Coordinator).LoadWeightsJSON,(*Coordinator).SaveSnapshots,(*Coordinator).SaveWeightsJSONexist inpkg/agentdrain/coordinator.goandpkg/agentdrain/miner.gobut are not documented.pkg/agentdrain.📊 Quality Scores (spot-checked packages)
cliworkflowparseragentdrainAction Items
FindOrFetchModelPricingreference inpkg/cli/README.md(rename source function to match, or correct the spec)pkg/cli/README.mdto document the 17 missing exported symbolspkg/workflow/README.mdto document the 23 missing exported symbolspkg/parser/README.mdto document the 4 missing exported symbolspkg/agentdrain/README.mdto document the 5 missing exported symbolsCloses #<this issue number>(orFixes/Resolves) in the PR description.