agentdocs

package

v1.27.0 Latest Latest Go to latest Published: Sep 7, 2026 License: BSD-3-Clause Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/dotwaffle/peeringdb-plus

Links

Open Source Insights

Documentation ¶

Overview ¶

Package agentdocs serves the installable PeeringDB Plus agent skill.

Index ¶

Constants
type Handler
- func NewHandler(options Options) (*Handler, error)
- func (h *Handler) Register(mux *http.ServeMux)
type Options

Constants ¶

View Source

const (
	// SkillPath is the raw skill document endpoint.
	SkillPath = "/skills/peeringdb-plus/SKILL.md"
	// ArchivePath is the installable skill archive endpoint.
	ArchivePath = "/skills/peeringdb-plus.zip"
	// WellKnownSkillPath is the standard Agent Skills document endpoint.
	WellKnownSkillPath = "/.well-known/agent-skills/peeringdb-plus/SKILL.md"
	// SkillIndexPath is the Agent Skills discovery index endpoint.
	SkillIndexPath = "/.well-known/agent-skills/index.json"
	// MCPServerCardPath is the MCP server discovery card endpoint.
	MCPServerCardPath = "/.well-known/mcp/server-card.json"
	// LLMSTextPath is the curated site index for language models.
	LLMSTextPath = "/llms.txt"

	// DiscoveryLinkHeader advertises the agent-facing discovery documents.
	DiscoveryLinkHeader = `` /* 292-byte string literal not displayed */

)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Handler ¶

type Handler struct {
	// contains filtered or unexported fields
}

Handler serves the raw skill document and its installable archive.

func NewHandler ¶

func NewHandler(options Options) (*Handler, error)

NewHandler validates options and returns a skill document handler.

func (*Handler) Register ¶

func (h *Handler) Register(mux *http.ServeMux)

Register mounts the agent document and discovery routes on mux.

type Options ¶

type Options struct {
	// PublicURL overrides request-derived origins in generated metadata. It
	// must be an absolute HTTP(S) origin with no credentials, path, query, or
	// fragment.
	PublicURL string
	// Version is the application version advertised in the MCP server card.
	Version string
	// SourceTime sets archive entry modification times. Zero values and dates
	// before the ZIP epoch use the ZIP epoch.
	SourceTime time.Time
}

Options configures a Handler.

Source Files ¶

View all Source files

handler.go

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