Help us shape the future of Go! Take the 2026 Go Developer Survey

docsgen

package
v0.5.0 Latest Latest
Warning

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

Go to latest
Published: Oct 16, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

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 Markdown

func Markdown(reg *registry.Registry) string

Markdown renders every tool in reg, grouped by CLI area.

func ScopesMarkdown

func ScopesMarkdown(reg *registry.Registry) string

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

type CoverageRow struct {
	Operation string
	Tools     []string
	Skip      string
}

CoverageRow is one operation of the pinned OpenAPI document that tailkeeper must answer for: the tools that call it, or why none does.

func Coverage

func Coverage(reg *registry.Registry) (rows []CoverageRow, problems []string)

Coverage maps the pinned document's required operations to the tools that call them (spec §20). problems lists every way the map is incomplete or wrong; the docs show them and a test fails on them.

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.

func Scopes

func Scopes(reg *registry.Registry) []ScopeUse

Scopes returns every OAuth scope the tools in reg declare, sorted by name.

Jump to

Keyboard shortcuts

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