Documentation
¶
Overview ¶
Package docsgen renders docs/tools.md from the registry, so the reference can never disagree with the code (`make docs-check` fails when it would).
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ScopesMarkdown ¶
ScopesMarkdown renders docs/scopes.md: every OAuth scope and the tools that use it, so a read credential can be created with what it needs and no more.
Types ¶
type CoverageRow ¶
CoverageRow is one operation of the pinned OpenAPI document that tailkeeper must answer for: the tools that call it, or why none does.
type ScopeUse ¶
type ScopeUse struct {
Scope string `json:"scope"`
// Tools need the scope for their result.
Tools []string `json:"tools"`
// PartialTools read part of their result with the scope, and still work,
// narrowed, without it (settings fields, key types).
PartialTools []string `json:"partialTools,omitempty"`
// AlphaOnly means only tools for alpha Tailscale features use the scope; MCP
// lists those tools only with --enable-alpha.
AlphaOnly bool `json:"alphaOnly,omitempty"`
// Plans names the Tailscale plans of plan-gated tools that use the scope, as
// "tool: plans".
Plans []string `json:"plans,omitempty"`
}
ScopeUse is one OAuth scope and the tools that declare it.
Click to show internal directories.
Click to hide internal directories.