Documentation
¶
Index ¶
- Constants
- func DecodeServers(raw map[string]json.RawMessage) (map[string]Server, []string)
- func Describe(name string, entry Entry) lockfile.MCPServer
- func NPMRegistry(server Server) string
- func NPMSpec(record lockfile.MCPServer) string
- func NotCarried(agent, name string, settings ...string) string
- func ParseServers(data []byte) (map[string]Server, []string, error)
- func ResolveNPM(ctx context.Context, client *http.Client, registry, name, spec string) (version, integrity string, err error)
- func Unrecorded(entries Entries, records []lockfile.MCPServer) []string
- type Config
- type Entries
- type Entry
- type OAuth
- type Server
- type Source
Constants ¶
const ( LauncherNPM = "npm" LauncherPyPI = "pypi" LauncherDocker = "docker" LauncherRemote = "remote" LauncherCommand = "command" )
Variables ¶
This section is empty.
Functions ¶
func DecodeServers ¶
DecodeServers decodes a name-to-server map one server at a time.
func Describe ¶
Describe classifies a server by what launches it and returns the lock record that can be written without network access. An npm registry package comes back with an empty Status: it still needs ResolveNPM.
func NPMRegistry ¶
NPMRegistry returns the registry a server's launcher will use as far as agentpack can see it: the server's own environment, then the process environment, then the public registry. Per-user .npmrc files are not read.
func NotCarried ¶
NotCarried names, for a warning, the settings of a server that an agent's MCP format has no place for.
func ParseServers ¶
ParseServers reads the MCP servers of a JSON (or JSONC) document in either published form: wrapped in "mcpServers", or the bare name-to-server map that Claude Code also accepts in a plugin's .mcp.json. A server that cannot be read is left out and named in the returned warnings; the others are kept.
Types ¶
type Entries ¶
type OAuth ¶
type OAuth struct {
ClientID string `toml:"client_id,omitempty"`
ClientSecret string `toml:"client_secret,omitempty"`
CallbackPort int `toml:"callback_port,omitempty"`
Scopes []string `toml:"scopes,omitempty"`
MetadataURL string `toml:"metadata_url,omitempty"`
}
OAuth is the OAuth client a remote MCP server is used with.
type Server ¶
type Server struct {
Type *string `toml:"type,omitempty" json:"type,omitempty"`
Command *string `toml:"command,omitempty" json:"command,omitempty"`
Args []string `toml:"args,omitempty" json:"args,omitempty"`
Env map[string]string `toml:"env,omitempty" json:"env,omitempty"`
URL *string `toml:"url,omitempty" json:"url,omitempty"`
Disabled *bool `toml:"disabled,omitempty" json:"disabled,omitempty"`
// Headers are sent with every request to a remote server. Like Env, they
// may hold credentials and never reach pack.lock.
Headers map[string]string `toml:"headers,omitempty" json:"headers,omitempty"`
// Cwd is the directory a local server is started in.
Cwd *string `toml:"cwd,omitempty" json:"cwd,omitempty"`
// OAuth holds the client settings of a remote server. Each agent spells
// them its own way, so the harness writers render them.
OAuth *OAuth `toml:"oauth,omitempty" json:"-"`
}
Server is the canonical MCP server definition shared by manifest loading, source merging, and harness-specific renderers.
func (Server) Definition ¶
Definition digests what a server definition runs: its type, command, arguments, and URL. Environment values are excluded so secrets never influence, or leak through, the lockfile.
func (Server) JSONObject ¶
JSONObject is the server in the JSON shape Claude Code, Cursor and Antigravity share: type, command, args, env, url, headers, disabled. Each writer adds or renames what its agent spells differently.