Genyleap/Docs
OpenProof / AI

Geben Sie AI den Vertrag, nicht Ihre Secrets.

OpenProof stellt eine öffentliche, dokumentationsorientierte AI-Oberfläche bereit: kompakte LLM-Indizes, einen erweiterten Textkorpus, den OpenAPI-3.1-Vertrag und einen schreibgeschützten MCP-Server für Suche, Endpoint-Lookup und Integrationshinweise.

Kanonische maschinenlesbare Quellen

RessourceZweck
/llms.txtKompakter Index für die gesamte Genyleap-Dokumentation.
/llms-full.txtErweiterter Genyleap/OpenProof-Textkorpus für Retrieval.
/openproof/llms.txtOpenProof-spezifische Navigation und verbindliche Quellenreihenfolge.
/openproof/llms-full.txtErweiterte Referenz für OpenProof-Bereitstellung und Entwicklung.
/openproof/api/openapi.yamlVerbindlicher HTTP-Vertrag nach OpenAPI 3.1.
/openproof/handbookMenschenlesbarer Bereitstellungs- und Entwicklerworkflow.
Quellenpriorität für Agents.

Verwenden Sie OpenAPI für Endpoint-/Schema-Fakten, das Handbuch für den Workflow, den API Guide für Protokollbeispiele, Configuration für typisierte Einstellungen, Provider Setup für Upstream-Anforderungen und Operations für Runbooks.

Öffentlicher Dokumentations-MCP

Kompatible MCP-Clients können sich verbinden mit:

MCPStreamable HTTP
https://docs.genyleap.com/openproof/mcp

Der Server ist absichtlich öffentlich, weil er ausschließlich öffentliche Dokumentation bereitstellt. Er hat keinen Pfad zu produktiven OpenProof-Secrets, Datenbanken, Sitzungen, Nutzern oder Operator-Dateien.

Werkzeuge

WerkzeugZweck
search_openproof_docsÖffentliches Handbuch und implementierungsnahe Dokumentation durchsuchen.
get_openproof_guideEinen fokussierten Leitfaden für Installation, OAuth/OIDC, Provider, Betrieb, Sicherheit oder AI zurückgeben.
get_openproof_endpointOpenAPI-Methode/-Pfad nachschlagen und den zugehörigen Vertragsauszug zurückgeben.
get_openproof_exampleDokumentierte Integrationsmuster für cURL, JavaScript/Node, PHP oder C++ zurückgeben.
get_openproof_checklistInstallations-, Entwickler- oder Produktions-Checklisten zurückgeben.
Absichtlich schreibgeschützt.

Der Dokumentations-MCP ist keine administrative Hintertür. Verwenden Sie für Änderungen an einer laufenden Bereitstellung separat authentifizierte Operator-Werkzeuge mit explizitem Audit und Least Privilege.

RAG- / Indexierungsleitfaden

  1. Indizieren Sie den OpenAPI-Vertrag getrennt vom Fließtext, damit Method-/Path-/Schema-Fakten strukturiert bleiben.
  2. Teilen Sie das Handbuch nach Überschriften und behalten Sie Codeblöcke bei dem Abschnitt, der sie erläutert.
  3. Speichern Sie Versionsmetadaten mit jedem Chunk; die Beispiele hier zielen auf OpenProof 1.1.0-rc1.
  4. Lassen Sie ein Modell widersprüchliche Dokumentation nicht stillschweigend auflösen. Machen Sie Abweichungen sichtbar und bevorzugen Sie aktuelle, implementierungsnahe Quellen.
  5. Speichern Sie reale Deployment-Werte — Client Secrets, Datenbank-URLs, Token und private Schlüssel — außerhalb des Retrieval-Korpus.

Sicherer Coding-Assistant-Prompt

promptBeispiel
Use only the OpenProof public documentation and OpenAPI contract.

Issuer: https://auth.example.com
Client type: browser
Redirect URI: https://app.example.com/oauth/callback
Scopes: openid profile offline_access

Implement Authorization Code + PKCE S256.
Validate state, returned issuer and ID-token signature/claims.
Do not hard-code secrets or log tokens.
Do not invent undocumented endpoints.

Sicherheitsgrenze für Agents

Geben Sie Folgendes nicht in öffentliche LLM-Prompts, RAG-Korpora oder den Dokumentations-MCP:

  • Provider-/API-Client-Secrets;
  • vertrauliche OAuth Client Secrets;
  • PostgreSQL-URLs/Passwörter;
  • Signing-/Encryption-/Private Keys;
  • Access- oder Refresh-Token;
  • Sitzungscookies;
  • Verifizierungssecrets, TOTP-Seeds oder Recovery Codes;
  • Live-Nutzer-/Sitzungszustand oder private Logs.

Verwenden Sie für Infrastrukturautomatisierung einen separaten authentifizierten Operator-MCP/-Service. Dokumentationszugriff und Produktionssteuerung sollten getrennte Vertrauensgrenzen bleiben.