docs/MCP.md: lead with connecting to the hosted server (connector sign-in), move local hyp mcp serve to the bottom

Chiusa Adatta ai principianti
  • Qualcosa non va?
#2,853 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
78/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
javascript
Ambito
documentation

Direzione di ricerca

Inizia da docs/MCP.md: riordina la pagina in modo che la connessione remota a /v1/mcp venga per prima e che la configurazione locale con hyp mcp serve finisca in fondo. Poi aggiungi una sezione "Sign in from a chat client" prima della configurazione del token dell'agente. Usa il testo di consenso della pagina Allow di LLP 0618 (#consent) e mantieni intatti tutti i blocchi mcp-config. Esegui test/core/docs-mcp-configs.test.js; è completato quando la pagina inizia con il server remoto e l'accesso, la configurazione locale è all'ultimo posto e quel test passa.

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

Descrizione

neutral:fix

Problem. docs/MCP.md (published at https://hypaware.ai/docs/mcp) leads with the local hyp mcp serve setup and documents only two paths: local, or remote with a minted agent token. The main way people connect is missing: adding https://api.hypaware.ai/v1/mcp to a chat client as a connector and signing in through HypAware's OAuth (LLP 0618). That path is live, it's what we submitted to Claude's Connectors Directory, and a user asked for it this week but couldn't find it in the docs.

Asked for (Hernan):

  1. Reorder the page around the remote server. Put connecting to /v1/mcp first. Move local hyp mcp serve to the bottom as the special case for a host that already runs hyp. Rewrite the intro, and the tip that recommends local, to match.
  2. Add a "Sign in from a chat client" section first, before the agent-token setup. Claude (claude.ai, Desktop, mobile):
    • Customize → Connectors → + Add → Add custom connector. Name HypAware, URL https://api.hypaware.ai/v1/mcp. No token or headers.
    • Connect, sign in to HypAware, then Allow. In a chat, turn it on under + → Connectors.
    • Team and Enterprise: an Owner first adds it under Organization settings → Connectors → Add → Custom → Web, then each member clicks Connect. The Claude Free plan allows one custom connector.
    • Source for the menu paths: https://support.claude.com/en/articles/11175166-getting-started-with-custom-connectors-using-remote-mcp
    • Say what the connection can do. Use the Allow page's own wording from LLP 0618 #consent: it reads the org's history and reports and marks recommendations, but it can't publish or delete reports or manage the org. Also cover the connection's lifetime and how to disconnect. The existing "List and revoke tokens" text already covers revoking connections.
  3. Keep the agent-token setup as the path for cloud agents, CI and clients without OAuth. The per-client blocks stay as they are.
  4. ChatGPT, in a follow-up PR. ChatGPT can't connect yet: the server only accepts Claude's OAuth callback, and a hypaware-server change opening it to any MCP client is in progress. Once that ships, add ChatGPT to the sign-in section. Don't document it before then.

Constraints. test/core/docs-mcp-configs.test.js checks every mcp-config block, so keep those markers intact. In hyparam/hypaware.ai, the llms.txt line for this page ("locally with hyp mcp serve or remotely with an agent token") needs updating to match. That's handled separately.

Done when: the page leads with the remote server and the sign-in section, local setup comes last, and the config test passes.

Lingua principale
JavaScript
Stelle
11
Fork
0
Merge medio
2h 25m
PR unite (30g)
311

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 hyparam/hypaware

Tutte le issue di hyparam/hypaware

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.