Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Cerrado
  • ¿Algo no está bien?
#1,183 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Ya se ha fusionado un pull request relacionado.

  • #1205 de @tgrunnagle — fusionado

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
68/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Área
documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
Lenguaje dominante
JavaScript
Estrellas
4
Forks
4
Merge medio
1 d 1 h
PR fusionados (30 d)
58

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de stacklok/docs-website

Todos los issues de stacklok/docs-website

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.