doctor

package
v0.8.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 19, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Result

type Result struct {
	Status         Status
	CheckName      string
	Message        string
	Recommendation string
}

Result holds the outcome of a single diagnostic check.

func CheckAgents

func CheckAgents(cfg *config.ProjectConfig) []Result

CheckAgents reports which agents are enabled or disabled.

func CheckConfig

func CheckConfig(root string) ([]Result, *config.ProjectConfig)

CheckConfig validates that the configuration file can be loaded and parsed. When strict loading fails but lenient loading succeeds (e.g., missing required fields from a newer version), CheckConfig returns a FAIL result with the validation error AND the leniently-loaded config so downstream checks still run.

func CheckSecrets

func CheckSecrets(cfg *config.ProjectConfig) []Result

CheckSecrets scans the configuration for missing environment variables. Only enabled MCP servers are considered; disabled servers are skipped.

func CheckStructure

func CheckStructure(root string) []Result

CheckStructure verifies that the required project directories exist.

type Status

type Status string

Status represents the health status of a check (OK, WARN, FAIL).

const (
	// StatusOK indicates the check passed.
	StatusOK Status = "OK"
	// StatusWarn indicates a potential issue that doesn't block functionality.
	StatusWarn Status = "WARN"
	// StatusFail indicates a critical issue that must be resolved.
	StatusFail Status = "FAIL"
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL