Référence du serveur MCP
Méthodes JSON-RPC, outils, paramètres, ressources et erreurs du serveur MCP de la documentation Wakastart.
This page has not been translated yet and is shown in French.
Le serveur MCP de la documentation répond en JSON-RPC 2.0 sur HTTP. Cette page sert à vérifier une intégration ou à écrire votre propre client ; pour brancher un assistant, suivez Configurer le serveur MCP.
Caractéristiques
| Élément | Valeur |
|---|---|
| Adresse | https://docs.wakastart.app/api/mcp |
| Transport | HTTP POST, une requête JSON-RPC par appel, réponse JSON (pas de flux) |
| Authentification | Aucune |
| Version du protocole annoncée | 2024-11-05 |
| Serveur | wakastart-docs-mcp 1.0.0 |
| Contenu | Pages françaises de la dernière version de la documentation |
| Cache | Aucun (Cache-Control: no-store) |
GET https://docs.wakastart.app/api/mcp renvoie une fiche descriptive du serveur, hors protocole MCP.
Méthodes
| Méthode | Rôle |
|---|---|
initialize | Poignée de main : version du protocole, nom du serveur, capacités tools et resources |
ping | Vérifie que le serveur répond ; résultat vide |
tools/list | Liste les outils et leur schéma d'entrée |
tools/call | Exécute un outil : params.name et params.arguments |
resources/list | Liste les ressources : une par page de la documentation |
resources/read | Lit une ressource : params.uri |
curl -s https://docs.wakastart.app/api/mcp \
-H 'Content-Type: application/json' \
-d '{
"jsonrpc": "2.0",
"id": 2,
"method": "tools/call",
"params": { "name": "search_docs", "arguments": { "query": "PKCE Discovery", "maxResults": "3" } }
}'Le résultat d'un outil est un contenu texte en Markdown : { "content": [{ "type": "text", "text": "…" }] }. Chaque outil lit les pages de cette documentation et cite la page d'où vient sa réponse ; les liens internes y sont absolus.
Outils
search_docs
Recherche plein texte dans les pages de la documentation. Renvoie les passages les plus pertinents avec la page source.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
query | chaîne | oui | Termes recherchés, 3 caractères au moins par terme : PKCE, droit applicatif, limite de débit |
section | chaîne | non | Identifiant d'une section, tel qu'il apparaît dans les URL : reference-api, authentification. Défaut : toutes |
maxResults | chaîne | non | Nombre de résultats, défaut 5, 20 au plus |
get_auth_flow
Pages qui décrivent la connexion des utilisateurs d'une wakapp, en Markdown, identiques à leur version .md : Discovery, puis Connecter vos utilisateurs et le guide du contexte choisi. La réponse se termine par la liste des autres pages de la section Authentification.
| Paramètre | Type | Obligatoire | Valeurs |
|---|---|---|---|
format | chaîne | non | summary : la page Discovery et la liste des pages ; full (défaut) : en plus, le guide de démarrage et le guide du contexte |
context | chaîne | non | frontend : SPA ; backend : application serveur et vérification d'un jeton côté serveur ; mobile : hôtes et redirect URIs |
get_endpoint_spec
Description d'un endpoint telle qu'elle figure dans la Référence API : introduction de la page, accès requis, paramètres et corps, exemples, réponses et erreurs. Si la méthode ne correspond pas, l'outil renvoie les méthodes documentées pour ce chemin ; si le chemin est inconnu, il propose des endpoints proches.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
path | chaîne | oui | Chemin tel qu'il figure dans la Référence API, par exemple /api/me, /discover/start-login ou /api/config/teams/{wid}. Un paramètre s'écrit {wid} ou :wid |
method | chaîne | oui | GET, POST, PUT, DELETE ou PATCH |
list_endpoints
Tous les endpoints décrits dans la Référence API, regroupés par page, avec leur méthode, leur chemin, une description courte et le lien de la page.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
tag | chaîne | non | Domaine : identifiant ou titre d'une page de la Référence API (equipes, Invitations, discovery, jeton-et-me…), ou segment de chemin (config, token). Un domaine inconnu renvoie la liste des domaines |
method | chaîne | non | GET, POST, PUT, DELETE ou PATCH |
get_error_code
Extrait de la page Codes d'erreur. Pour un statut HTTP : sa cause et sa résolution, puis les messages de ce statut dans chaque domaine. Pour un domaine : ses erreurs. Pour un extrait de message : les lignes qui le citent. Un code inconnu renvoie la liste des statuts et des sections de la page.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
code | chaîne | oui | Statut HTTP (400, 401, 403, 404, 409, 429, 500…), domaine (Invitations, Discovery, HDS…) ou extrait d'un message (Token revoked, Droit applicatif requis) |
Note
Les outils renvoient le texte des pages publiées, sans résumé ni contenu propre : leur réponse est celle que vous liriez sur ce site.
Ressources
| URI | Type | Contenu |
|---|---|---|
wakastart://docs/<section>/<page> | text/markdown | Une page de la documentation, frontmatter compris. La page d'accueil d'une section a pour identifiant index : wakastart://docs/reference-api/index |
Les endpoints se consultent dans les pages de la Référence API, ou avec list_endpoints et get_endpoint_spec.
curl -s https://docs.wakastart.app/api/mcp \
-H 'Content-Type: application/json' \
-d '{"jsonrpc":"2.0","id":3,"method":"resources/read","params":{"uri":"wakastart://docs/reference-api/discovery"}}'Erreurs
Les erreurs sont renvoyées avec le statut HTTP 200, dans le champ error de la réponse JSON-RPC.
| Code | Message | Cause |
|---|---|---|
-32700 | Parse error: invalid JSON | Corps qui n'est pas du JSON |
-32600 | Invalid Request: missing jsonrpc or method | Enveloppe JSON-RPC incomplète |
-32601 | Method not found: <méthode> | Méthode non prise en charge |
-32601 | Tool not found: <outil> | Outil inconnu |
-32601 | Resource not found: <uri> | Page inconnue |
-32602 | Missing required param: name ou Missing required param: uri | Paramètre manquant |
-32603 | Internal error | Erreur du serveur ; le détail est dans error.data |