给 AI contract,而不是你的 secret。
OpenProof 提供公开、documentation-first 的 AI surface:紧凑 LLM index、扩展 text corpus、OpenAPI 3.1 contract,以及用于搜索、endpoint lookup 与集成指导的 read-only MCP server。
规范机器可读来源
| 资源 | 用途 |
|---|---|
/llms.txt | 全部 Genyleap 文档的紧凑 index。 |
/llms-full.txt | 用于 retrieval 的扩展 Genyleap/OpenProof text corpus。 |
/openproof/llms.txt | 仅 OpenProof 使用的 navigation 与权威 source order。 |
/openproof/llms-full.txt | 扩展 OpenProof deployment 与 developer reference。 |
/openproof/api/openapi.yaml | 权威 OpenAPI 3.1 HTTP contract。 |
/openproof/handbook | 人类可读的 deployment + developer workflow。 |
Agent 的来源优先级。
endpoint/schema 事实使用 OpenAPI;workflow 使用 handbook;协议示例使用 API Guide;typed 设置使用 Configuration;upstream 要求使用 Provider Setup;runbook 使用 Operations。
公开 documentation MCP
兼容 MCP client 可连接到:
https://docs.genyleap.com/openproof/mcp
该 server 有意公开,因为它只暴露公开文档。它无法访问 production OpenProof secret、database、session、user 或 operator file。
工具
| 工具 | 用途 |
|---|---|
search_openproof_docs | 搜索公开 handbook 与 implementation-aligned documentation。 |
get_openproof_guide | 返回 install、OAuth/OIDC、provider、operations、security 或 AI 的聚焦指南。 |
get_openproof_endpoint | 查找 OpenAPI method/path 并返回对应 contract excerpt。 |
get_openproof_example | 返回 cURL、JavaScript/Node、PHP 或 C++ 的已文档化 integration pattern。 |
get_openproof_checklist | 返回 installation、developer 或 production checklist。 |
设计为 read-only。
docs MCP 不是管理 backdoor。要修改实时 deployment,应使用独立认证的 operator tooling,并启用明确 audit 与 least privilege。
RAG / indexing 指南
- 将 OpenAPI contract 与 prose 分开建立 index,以保持 method/path/schema 事实的结构化。
- 按 heading 对 handbook 分 chunk,并让 code block 与解释它的 section 保持在一起。
- 每个 chunk 都应保存 version metadata;本文示例面向 OpenProof 1.1.0-rc1。
- 不要让模型静默 reconcile 相互冲突的 docs。应明确显示差异,并优先采用当前 implementation-aligned source。
- 真实 deployment 值——client secret、database URL、token 与 private key——应保存在 retrieval corpus 之外。
安全 coding assistant prompt
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.
Agent 的安全边界
不要将以下内容放入公开 LLM prompt、RAG corpus 或 documentation MCP:
- provider/API client secret;
- 机密 OAuth client secret;
- PostgreSQL URL/password;
- signing/encryption/private key;
- access token 或 refresh token;
- session cookie;
- verification secret、TOTP seed 或 recovery code;
- 实时 user/session state 或 private log。
基础设施自动化应使用独立且已认证的 operator MCP/service。documentation access 与 production control 应保持为不同的 trust boundary。