Quellcode durchsuchen

update sur le titrage attendu dans dokuwiki

Intersel vor 4 Wochen
Ursprung
Commit
2825284df6
4 geänderte Dateien mit 78 neuen und 5 gelöschten Zeilen
  1. 17 0
      .cursor/rules/dokuwiki.mdc
  2. 11 0
      README.md
  3. 21 1
      src/dokuwiki_mcp/mcp/server.py
  4. 29 4
      src/dokuwiki_mcp/mcp/tools.py

+ 17 - 0
.cursor/rules/dokuwiki.mdc

@@ -34,6 +34,23 @@ DokuWiki centralise les documentations techniques (conception, développement, d
 
 Un texte vide sur `save_page` **supprime** une page existante : le signaler clairement dans le plan.
 
+## Rédaction des pages
+
+- Syntaxe DokuWiki uniquement, pas de Markdown : listes `  * ` et `  - `, gras `**`, code `''code''`, tableaux `^ en-tête ^` / `| cellule |`, liens `[[espace:page|libellé]]`, retour à la ligne forcé `\\ ` en fin de ligne.
+- Le titre principal est en niveau 1 (`====== Titre ======`) et nomme le projet concerné, pas seulement le sujet de la page.
+- Les sections suivantes restent en niveau 1, préfixées par ` - ` pour la numérotation automatique : `====== - Contexte ======`. On ne descend pas au niveau 2 juste après le titre principal : cela fait perdre un niveau de hiérarchie pour rien. Les sous-sections descendent ensuite normalement : `===== - Sous-section =====`, puis `==== - Détail ====`.
+
+```
+====== Projet X - Sujet de la page ======
+====== - Première section ======
+===== - Sous-section =====
+==== - Détail ====
+====== - Deuxième section ======
+```
+
+- Regrouper un sujet dans une seule page ; ne créer des sous-pages que sur demande explicite.
+- Lire la page existante avant de la réécrire, pour conserver titre, métadonnées (created, updated) et style. Renseigner `summary` à chaque enregistrement.
+
 ## Gestion d'erreurs
 
 - Si l'outil renvoie `ok: false`, expliquer le `message` / `code` sans relancer en boucle.

+ 11 - 0
README.md

@@ -62,6 +62,17 @@ Ressources :
 
 `save_page` et `append_page` invalident le cache de la page écrite.
 
+## Conventions de rédaction
+
+Le serveur transmet ses conventions aux clients MCP via les `instructions` de l'initialisation (`src/dokuwiki_mcp/mcp/server.py`, constante `INSTRUCTIONS`) ; elles sont rappelées dans la description des outils d'écriture. En résumé :
+
+- syntaxe DokuWiki uniquement, pas de Markdown ;
+- titre principal en niveau 1 (`====== Titre ======`), nommant le projet concerné ;
+- sections suivantes en niveau 1 numérotées (`====== - Section ======`), sans passer au niveau 2 juste après le titre principal ; sous-sections en `=====` puis `====` ;
+- un sujet par page, sous-pages seulement sur demande.
+
+Pour modifier ces conventions, éditer `INSTRUCTIONS` dans `server.py` et la règle `.cursor/rules/dokuwiki.mdc`.
+
 ## Tests
 
 ```bash

+ 21 - 1
src/dokuwiki_mcp/mcp/server.py

@@ -4,7 +4,27 @@ from __future__ import annotations
 
 from mcp.server.fastmcp import FastMCP
 
-mcp = FastMCP("DokuWiki")
+INSTRUCTIONS = """\
+Serveur MCP du wiki Intersel / Livinweb (DokuWiki).
+
+Conventions de rédaction des pages (save_page, append_page) :
+
+- Syntaxe DokuWiki uniquement, jamais de Markdown : titres ====== ======, listes "  * " et "  - ",
+  gras **texte**, code ''code'', tableaux ^ en-tête ^ / | cellule |, liens [[espace:page|libellé]],
+  retour à la ligne forcé "\\\\ " en fin de ligne.
+- Le titre principal de la page est en niveau 1 (====== Titre ======) et nomme le projet concerné
+  (ex. « Clôture des temps client SPMP - Fonctionnalités à réaliser »), pas seulement le sujet.
+- Les sections suivantes restent en niveau 1, préfixées par " - " pour la numérotation automatique :
+  ====== - Contexte ======. Ne pas descendre au niveau 2 juste après le titre principal : cela fait
+  perdre un niveau de hiérarchie pour rien. Les sous-sections descendent ensuite normalement :
+  ===== - Sous-section =====, puis ==== - Détail ====.
+- Regrouper un sujet dans une seule page ; ne créer des sous-pages que sur demande explicite.
+- Avant d'écrire, lire la page existante (dokuwiki://page/{id}) pour conserver son titre, ses
+  métadonnées (created, updated) et son style. Renseigner summary à chaque enregistrement.
+- Un texte vide sur save_page supprime la page : le signaler avant d'appeler l'outil.
+"""
+
+mcp = FastMCP("DokuWiki", instructions=INSTRUCTIONS)
 
 # Enregistrement des outils et ressources auprès de l'instance unique.
 from dokuwiki_mcp.mcp import resources as _resources  # noqa: E402,F401

+ 29 - 4
src/dokuwiki_mcp/mcp/tools.py

@@ -48,11 +48,24 @@ def search_pages(
 )
 def save_page(
     page: Annotated[str, Field(description="Identifiant de la page wiki (ex. wiki:syntax).")],
-    text: Annotated[str, Field(description="Texte wiki à enregistrer. Un texte vide supprime une page existante.")],
+    text: Annotated[
+        str,
+        Field(
+            description=(
+                "Texte en syntaxe DokuWiki (pas de Markdown). Titre principal et sections en niveau 1 "
+                "(====== Titre ======, puis ====== - Section ======), sous-sections en ===== puis ====. "
+                "Un texte vide supprime une page existante."
+            )
+        ),
+    ],
     summary: Annotated[str, Field(description="Résumé de la modification.")] = "",
     isminor: Annotated[bool, Field(description="Indique s'il s'agit d'une modification mineure.")] = False,
 ) -> Any:
-    """Enregistre le texte wiki sur la page. Crée la page si besoin. Un texte vide supprime une page existante."""
+    """Enregistre le texte wiki sur la page. Crée la page si besoin. Un texte vide supprime une page existante.
+
+    Respecter les conventions de rédaction du serveur : syntaxe DokuWiki, titre principal nommant le
+    projet, sections en niveau 1 numérotées (" - "), pas de niveau 2 juste après le titre principal.
+    """
     result = _rpc(
         "core.savePage",
         {"page": page, "text": text, "summary": summary, "isminor": bool(isminor)},
@@ -70,11 +83,23 @@ def save_page(
 )
 def append_page(
     page: Annotated[str, Field(description="Identifiant de la page wiki (ex. wiki:syntax).")],
-    text: Annotated[str, Field(description="Texte wiki à ajouter à la fin de la page.")],
+    text: Annotated[
+        str,
+        Field(
+            description=(
+                "Texte en syntaxe DokuWiki (pas de Markdown) à ajouter à la fin de la page. "
+                "Une nouvelle section se déclare en niveau 1 numéroté : ====== - Section ======."
+            )
+        ),
+    ],
     summary: Annotated[str, Field(description="Résumé de la modification.")] = "",
     isminor: Annotated[bool, Field(description="Indique s'il s'agit d'une modification mineure.")] = False,
 ) -> Any:
-    """Ajoute du texte à la fin d'une page DokuWiki. Crée la page si elle n'existe pas."""
+    """Ajoute du texte à la fin d'une page DokuWiki. Crée la page si elle n'existe pas.
+
+    Respecter les conventions de rédaction du serveur : syntaxe DokuWiki, sections en niveau 1
+    numérotées (" - "), sous-sections en ===== puis ====.
+    """
     result = _rpc(
         "core.appendPage",
         {"page": page, "text": text, "summary": summary, "isminor": bool(isminor)},