Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Connector Gateway intro: add how it works and full admin scope

Chiusa
  • Qualcosa non va?
#1,183 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Una pull request collegata è già stata integrata.

  • #1205 di @tgrunnagle — integrata

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
68/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Ambito
documentation

Direzione di ricerca

Start with docs/connector-gateway/index.mdx and inspect connectorGatewaySidebar plus the configure page's flow diagram. Review #1176 and #1177 for prerequisite and policy context, then update the introduction, admin-area links, prerequisites, and vMCP comparison. Done means the page explains the request flow and roles, lists all four admin areas, and avoids duplicated pointers.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation enhancement needs-triage

Part of #1175. Page: docs/connector-gateway/index.mdx

Problems

  1. It doesn't explain how the gateway works or who does what (lines 18-24). The page says what the gateway is, but not how anyone gets value from it. There are two roles:

    • Admins register connectors and grant access.
    • Users connect an MCP client (Claude Code, Claude, Codex, Cursor, VS Code) to a single gateway endpoint and sign in once per connector.

    The only diagram of the flow is on the configure page.

  2. "What you administer here" is incomplete, and the sidebar doesn't match the console (lines 38-42). In the console, the Connectors admin nav group has four items: Connectors, Identity Providers, Managed Secrets, and Tool Usage. The docs put identity providers and managed secrets under Platform → Identity and directory, and this list doesn't mention them.

  3. The vMCP comparison implies a difference that isn't there (line 32). It lists "multiple authentication methods" as a vMCP advantage, but the Connector Gateway supports five auth types in the console and eight through the API.

  4. The directory-groups pointer repeats at lines 19 and 49-51, and access is also policy-based (see #1177). "Before you start" (lines 44-47) is a single link.

Recommendations

  • Add a short "How it works" section: the request flow (client → gateway → directory policy → connector), plus the admin and user roles, with links to each
  • List all four admin areas with links. Consider adding sidebar links to the identity providers and managed secrets pages in connectorGatewaySidebar.
  • Turn the vMCP section into a comparison table covering:
    • who picks the tools: admins and users vs. a fixed config
    • how authorization works: per-user connector policy vs. ToolhiveAuthorizationPolicy
    • tool filtering and renaming: users narrow their own tools vs. admin-defined
    • who it's for: people vs. applications
  • Link ToolhiveAuthorizationPolicy
  • Replace "Before you start" with real prerequisites: gateway deployed (#1176), at least one directory group, and identity providers or managed secrets for connectors that need auth
  • State the directory-groups pointer once
Lingua principale
JavaScript
Stelle
4
Fork
4
Merge medio
1g 1h
PR unite (30g)
58

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di stacklok/docs-website

Tutte le issue di stacklok/docs-website

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.