assistantkb

README

Secure MCP Tunnel client docs

This folder contains customer-facing operator docs and contributor docs for tunnel-client, the customer-run agent behind Secure MCP Tunnel.

Find The Right Guide

If you need to...	Read...
Connect a local or private MCP server to ChatGPT or Codex	onboarding.md
Explain the outbound-only network model or trust boundary	architecture.md
Implement a tunnel client in another language	protocol.md and openapi.json
Provision tunnel roles, groups, IDs, or API keys	permissions.md
Choose Docker, Kubernetes, or VM deployment	deployment/overview.md
Debug readiness, connector discovery, OAuth, or support bundles	troubleshooting.md

Start Here

• Public Secure MCP Tunnel guide: developers.openai.com/api/docs/guides/secure-mcp-tunnels
• Shareable end-user guide: end-user-guide.md
• Onboarding (recommended first read): onboarding.md
• Permissions, roles, and groups: permissions.md
• Architecture diagrams: architecture.md
• Connector behavior: connectors.md
• Wire protocol for client implementers: protocol.md
• OpenAPI contract: openapi.json
• Enterprise customer handoff: enterprise-customer-onboarding.md

Operator docs

• Configuration reference: configuration.md
• Deployments: deployment/overview.md
• Troubleshooting: troubleshooting.md
• Connector behavior and pitfalls: connectors.md

Maintainer / contributor docs

• Guide theme and visual manifest: pdf/
• Guide HTML archive command: make end-user-guide-html
• Guide slide deck command: make end-user-guide-slides
• Guide screenshot refresh command: make end-user-guide-screenshots
• Development & testing: development.md
• Wire protocol and OpenAPI contract: protocol.md, openapi.json
• Roadmap / design notes: roadmap.md

Documentation

Index

• func BinaryAcquisitionGuidanceForOS(goos string) (buildCommand string, wrapperCommand string, binaryFlag string)
• func BuildPromptContext(prompt string) string
• func FormatPromptContext(intro []string, matchPrefix string, matches []Match) string
• type Match
  • func Search(prompt string, limit int) []Match
  • func SearchFS(prompt string, fsys fs.ReadFileFS, paths []string, sourcePrefix string, ...) []Match

Functions

func BinaryAcquisitionGuidanceForOS

func BinaryAcquisitionGuidanceForOS(goos string) (buildCommand string, wrapperCommand string, binaryFlag string)

func BuildPromptContext

func BuildPromptContext(prompt string) string

func FormatPromptContext

func FormatPromptContext(intro []string, matchPrefix string, matches []Match) string

Types

type Match

type Match struct {
	Path    string
	Heading string
	Excerpt string
	Score   int
}

func Search

func Search(prompt string, limit int) []Match

func SearchFS

func SearchFS(prompt string, fsys fs.ReadFileFS, paths []string, sourcePrefix string, limit int, maxExcerptChars int) []Match