Genyleap/Docs
OpenProof / هوش مصنوعی

قرارداد را به AI بدهید، نه secrets خود را.

OpenProof یک سطح عمومی و documentation-first برای AI ارائه می‌کند: indexهای فشردهٔ LLM، corpus متنی گسترش‌یافته، قرارداد OpenAPI 3.1 و یک MCP server فقط‌خواندنی برای جست‌وجو، lookup endpoint و راهنمای یکپارچه‌سازی.

منابع مرجع machine-readable

منبعکاربرد
/llms.txtindex فشرده برای همهٔ مستندات جنی‌لیپ.
/llms-full.txtcorpus متنی گسترش‌یافتهٔ Genyleap/OpenProof برای retrieval.
/openproof/llms.txtnavigation مخصوص OpenProof و ترتیب مرجع منابع.
/openproof/llms-full.txtمرجع گسترش‌یافتهٔ استقرار و توسعهٔ OpenProof.
/openproof/api/openapi.yamlقرارداد مرجع HTTP بر پایهٔ OpenAPI 3.1.
/openproof/handbookجریان استقرار و توسعهٔ قابل‌خواندن برای انسان.
اولویت منابع برای agentها.

برای واقعیت‌های endpoint/schema از OpenAPI، برای workflow از handbook، برای نمونه‌های پروتکل از API Guide، برای تنظیمات typed از Configuration، برای نیازمندی‌های upstream از Provider Setup و برای runbookها از Operations استفاده کنید.

MCP عمومی مستندات

clientهای سازگار با MCP می‌توانند به این آدرس متصل شوند:

MCPHTTP قابل‌جریان
https://docs.genyleap.com/openproof/mcp

این server عمداً عمومی است، چون فقط مستندات عمومی را ارائه می‌کند. هیچ مسیری به secrets، database، session، user یا فایل‌های operator در محیط عملیاتی OpenProof ندارد.

ابزارها

ابزارکاربرد
search_openproof_docshandbook عمومی و مستندات همسو با implementation را جست‌وجو کنید.
get_openproof_guideراهنمای متمرکز برای نصب، OAuth/OIDC، providerها، عملیات، امنیت یا AI دریافت کنید.
get_openproof_endpointmethod/path مربوط به OpenAPI را lookup کنید و بخش مربوط از قرارداد را دریافت کنید.
get_openproof_examplepatternهای مستندشدهٔ یکپارچه‌سازی برای cURL، JavaScript/Node، PHP یا C++ را دریافت کنید.
get_openproof_checklistچک‌لیست نصب، توسعه‌دهنده یا محیط عملیاتی را دریافت کنید.
عمداً فقط‌خواندنی.

MCP مستندات یک backdoor مدیریتی نیست. برای تغییر یک deployment زنده، از ابزار operator با authentication مستقل، audit صریح و least privilege استفاده کنید.

راهنمای RAG / indexing

  1. قرارداد OpenAPI را جدا از متن prose index کنید تا واقعیت‌های method/path/schema ساختاریافته باقی بمانند.
  2. handbook را بر اساس headingها chunk کنید و code blockها را همراه با بخشی که آن‌ها را توضیح می‌دهد نگه دارید.
  3. metadata نسخه را با هر chunk نگه دارید؛ نمونه‌های اینجا OpenProof 1.1.0-rc1 را هدف می‌گیرند.
  4. اجازه ندهید مدل به‌صورت پنهانی مستندات متعارض را reconcile کند. اختلاف‌ها را آشکار کنید و منابع فعلیِ همسو با implementation را ترجیح دهید.
  5. مقادیر واقعی deployment — شامل client secret، URL پایگاه‌داده، token و private key — را خارج از corpus بازیابی نگه دارید.

prompt امن برای دستیار کدنویسی

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ها

موارد زیر را در prompt عمومی LLM، corpusهای RAG یا MCP مستندات قرار ندهید:

  • client secretهای provider/API؛
  • client secretهای محرمانهٔ OAuth؛
  • URL/passwordهای PostgreSQL؛
  • کلیدهای signing/encryption/private؛
  • access token یا refresh token؛
  • cookieهای نشست؛
  • verification secret، TOTP seed یا recovery code؛
  • state زندهٔ user/session یا log خصوصی.

برای اتوماسیون زیرساخت از MCP/service جداگانه و احرازشدهٔ operator استفاده کنید. دسترسی به مستندات و کنترل محیط عملیاتی باید دو trust boundary متفاوت باقی بمانند.