Guia de Intercanvi de Corpus de Docs
A Simple Vista
Què: Substituir o ampliar el corpus de documents utilitzat per decision_gate_docs_search i MCP resources/list + resources/read.
Per què: Adapteu la guia d’execució de l’LLM al vostre entorn, polítiques o documentació interna.
On: decision-gate.toml sota [docs].
Com es construeix el corpus de documents
- Valors per defecte integrats (temps de compilació, sense I/O de xarxa).
- Documents addicionals opcionals carregats des de
docs.extra_paths(fitxers o directoris).
Els documents es carreguen una vegada en iniciar el servidor i es desant en un catàleg a la memòria.
Pas 1: Prepara els teus documents
Requisits:
- Fitxers Markdown (
.md) només. - Cada document ha d’incloure un encapçalament
# Títol. - Utilitzeu
##/###encapçalaments per a seccions cercables. - Mantingueu els fitxers per sota del límit configurat
docs.max_doc_bytes.
Notes:
- Els noms de fitxers es converteixen en ID de documents (sanitzats a minúscules + guions baixos).
- Els documents personalitzats se’ls assigna el rol
patternper defecte. - Els fitxers buits es salten amb advertències.
Pas 2: Actualitzar decision-gate.toml
Substituïu el corpus per defecte amb un directori personalitzat:
[docs]
enabled = true
enable_search = true
enable_resources = true
include_default_docs = false
extra_paths = ["./my-docs"]
max_doc_bytes = 262144
max_total_bytes = 1048576
max_docs = 32
max_sections = 10
Amplieu el corpus per defecte amb alguns fitxers addicionals:
[docs]
enabled = true
enable_search = true
enable_resources = true
include_default_docs = true
extra_paths = ["./overrides/llm_playbook.md", "./runbooks"]
Comportament que s’espera:
- Els camins que falten fallen en l’inici amb un error de configuració.
- Els documents de gran mida es salten amb advertències.
- Es fan complir els límits de mida total / comptatge.
Pas 3: Assegureu-vos de la Visibilitat de l’Eina (Opcional)
La cerca de documents és una eina. Si filtreu eines, assegureu-vos que sigui visible:
[server.tools]
mode = "filter"
allowlist = ["decision_gate_docs_search", "scenario_define", "scenario_start"]
denylist = []
Si docs.enabled = false o docs.enable_search = false, l’eina està oculta i les trucades retornen UnknownTool.
Pas 4: Reinicia el servidor
Els documents es carreguen només a l’inici. Reinicieu per agafar nou contingut. Les advertències sobre documents saltats es imprimeixen a stderr.
Pas 5: Valida el Corpus
Cerca (eines/crida):
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "decision_gate_docs_search",
"arguments": { "query": "precheck vs live", "max_sections": 3 }
}
}
Llista de recursos (resources/list):
{ "jsonrpc": "2.0", "id": 2, "method": "resources/list" }
Recursos llegits (resources/read):
{
"jsonrpc": "2.0",
"id": 3,
"method": "resources/read",
"params": { "uri": "decision-gate://docs/custom/my_doc" }
}
Solució de problemes
- Search returns no results: empty query returns an overview; otherwise confirma que els encapçalaments existeixen i que el corpus està carregat.
- El servidor falla en iniciar: falta un camí en
docs.extra_paths. - Eina que falta de tools/list: comprova els
[docs]commutadors i[server.tools]. - Error en la lectura del recurs: assegureu-vos que la URI coincideixi amb
resources/list.