harness

package
v0.3.3 Latest Latest
Warning

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

Go to latest
Published: Apr 10, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Install

func Install(opts InstallOpts) (string, error)

Install configures context-mcp as an MCP server for the given client. Returns a human-readable status message.

func PrintConfig

func PrintConfig(opts PrintConfigOpts) (string, error)

PrintConfig returns the config snippet for manual installation.

func Uninstall

func Uninstall(opts UninstallOpts) (string, error)

Uninstall removes context-mcp configuration from the given client.

Types

type Client

type Client string

Client represents a supported agent client.

const (
	ClientClaudeCode Client = "claude-code"
	ClientCodex      Client = "codex"
)

type DoctorCheck

type DoctorCheck struct {
	Name    string
	Passed  bool
	Message string
	Fix     string // corrective step if failed
}

DoctorCheck represents a single diagnostic check result.

func Doctor

func Doctor(opts DoctorOpts) ([]DoctorCheck, error)

Doctor runs diagnostic checks and returns results.

type DoctorOpts

type DoctorOpts struct {
	Client   Client // if empty, check all clients
	RepoRoot string // absolute path to repo root (optional; auto-detected if empty)
}

DoctorOpts contains options for the doctor command.

type InstallOpts

type InstallOpts struct {
	Client    Client
	Profile   string            // core, extended, full
	RepoRoot  string            // absolute path to repo
	Force     bool              // overwrite existing config
	Scope     string            // "user" (default), "local", "project" — Claude Code only
	Transport string            // "stdio" (default), "http", "sse"
	URL       string            // HTTP/SSE endpoint URL (required when transport != stdio)
	EnvVars   map[string]string // environment variables to pass to MCP server
}

InstallOpts contains options for installing context-mcp into a client.

type PrintConfigOpts

type PrintConfigOpts struct {
	Client    Client
	Profile   string
	RepoRoot  string
	Scope     string            // "user" (default), "local", "project" — Claude Code only
	Transport string            // "stdio" (default), "http", "sse"
	URL       string            // HTTP/SSE endpoint URL
	EnvVars   map[string]string // environment variables to pass to MCP server
}

PrintConfigOpts contains options for printing the config snippet.

type UninstallOpts

type UninstallOpts struct {
	Client Client
	Scope  string // optional; if empty, uses claude CLI default
}

UninstallOpts contains options for uninstalling.

Jump to

Keyboard shortcuts

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