MCP Tools Reference: developerknowledge.googleapis.com

ابزار: search_documents

از این ابزار برای پیدا کردن اسناد مربوط به محصولات توسعه‌دهنده Google استفاده کنید. این اسناد حاوی میاناهای برنامه‌سازی کاربردی رسمی، تکه‌کدها، یادداشت‌های انتشار، روال‌های مطلوب، راهنماها، اطلاعات اشکال‌زدایی، و غیره است. این خط‌مشی محصولات و دامنه‌های زیر را پوشش می‌دهد:

  • ADK: adk.dev

  • ‫Android: developer.android.com

  • Apigee: docs.apigee.com

  • ‫Chrome: developer.chrome.com

  • Dart: dart.dev

  • Firebase: firebase.google.com

  • ‫Flutter: ‏ docs.flutter.dev

  • Fuchsia: fuchsia.dev

  • ‫Gemini CLI: geminicli.com

  • Genkit: genkit.dev

  • Go: go.dev

  • Google AI: ai.google.dev

  • ‫Google Antigravity: antigravity.google

  • Google Cloud: cloud.google.com & docs.cloud.google.com

  • Google Developers،‏ Ads، «جستجو»، Google Maps،‏ Youtube: developers.google.com

  • Google Home: developers.home.google.com

  • پلاتفرم Google Maps: mapsplatform.google.com

  • ‫Google Workspace: knowledge.workspace.google.com

  • TensorFlow: www.tensorflow.org

  • وب: web.dev

این ابزار بخش‌هایی از نوشتار، نام‌ها، و شناسه منبع یکسان را برای اسناد منطبق برمی‌گرداند. وقتی به نمونه‌های کد دقیق، پرچم‌های CLI، پیام‌های خطای خاص، راهنماهای آموزشی کامل، یا جستجوی کلیدواژه قطعی نیاز دارید، search_documents و سپس get_documents را ترجیح دهید. اگر بخش‌های برگردانده‌شده به‌اندازه کافی جزئیات ندارند تا به سؤال کاربر پاسخ دهند، از get_documents با parent از خروجی این ابزار استفاده کنید تا محتوای کامل سند را بازیابی کنید. When answering the user, always cite the authoritative source document resource names (documents/...) or URIs.

نمونه کد زیر نحوه استفاده از curl برای فراخوانی ابزار MCP search_documents را نشان می‌دهد.

درخواست Curl
curl --location 'https://developerknowledge.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "search_documents",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

طرح‌واره ورودی

طرح‌واره درخواست برای search_documents. از فیلد query برای جستجوی اسناد توسعه‌دهنده Google مرتبط استفاده کنید.

SearchDocumentChunksRequest

نمایش JSON
{
  "query": string
}
فیلدها
query

string

الزامی. رشته پُرسمان خام ارائه‌شده توسط کاربر، مانند «چگونه یک دسته Cloud Storage ایجاد کنیم؟».

طرح‌واره برونداد

طرح‌واره پاسخ برای search_documents.

SearchDocumentChunksResponse

نمایش JSON
{
  "results": [
    {
      object (DocumentChunk)
    }
  ]
}
فیلدها
results[]

object (DocumentChunk)

نتایج جستجو برای پُرسمان ارائه‌شده. هر DocumentChunk در این فهرست حاوی گزیده‌ای از محتوای مرتبط با پُرسمان جستجو است. از فیلد DocumentChunk.parent هر نتیجه با get_documents برای بازیابی محتوای کامل سند استفاده کنید.

DocumentChunk

نمایش JSON
{
  "parent": string,
  "id": string,
  "content": string
}
فیلدها
parent

string

فقط خروجی. نام منبع سندی که این بخش از آن است. قالب: documents/{uri_without_scheme} نمونه: documents/docs.cloud.google.com/storage/docs/creating-buckets

id

string

فقط خروجی. شناسه این بخش در سند. شناسه قطعه در یک سند یکتا است، اما در سطح جهانی در بین اسناد یکتا نیست. شناسه قطعه ثابت نیست و ممکن است درطول زمان تغییر کند.

content

string

فقط خروجی. محتوای تکه سند.

حاشیه‌نویسی‌های ابزار

حاشیه‌نویسی‌های ابزار به کارخواهان MCP ارسال می‌شود تا خطر اصلی ابزار موردنظر را شرح دهد. اکثر کارخواه‌ها این راهنمایی‌ها را غیرقابل‌اعتماد تلقی می‌کنند، اما می‌توان از آن‌ها برای تصمیم‌گیری درباره زمان ارسال پیام‌واره تأیید به کاربر استفاده کرد.

همراه با رشته عنوان، نکات بولی زیر به‌صورت زیر تعریف می‌شوند:

  • ‫readOnlyHint: اگر درست باشد، ابزار محیط خود را تغییر نمی‌دهد. پیش‌فرض: false.
  • ‫destructiveHint: اگر درست باشد، ابزار می‌تواند کنش‌های مخرب انجام دهد. اگر نادرست باشد، ابزار فقط می‌تواند کنش‌های افزایشی انجام دهد. پیش‌فرض: true.
  • idempotentHint: اگر درست باشد، فراخوانی مکرر ابزار با همان متغیرهای مستقل تأثیر بیشتری بر محیط آن نخواهد داشت. پیش‌فرض: false.
  • ‫openWorldHint: اگر درست باشد، ابزار می‌تواند با «دنیای باز» نهادهای خارجی تعامل داشته باشد. اگر نادرست باشد، ابزار فقط می‌تواند با نهادهای داخلی تعامل داشته باشد. برای مثال، ابزار جستجوی وب از نوع دنیای باز است، درحالی‌که ابزار حافظه از نوع دنیای باز نیست.

Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌