MCP Tools Reference: developerknowledge.googleapis.com

ابزار: get_documents

از این ابزار برای بازیابی محتوای کامل یک سند یا حداکثر ۲۰ سند در یک فراخوانی استفاده کنید. نام اسناد باید از فیلد parent نتایج حاصل از فراخوانی ابزار search_documents یا فیلد references برگردانده‌شده توسط ابزار answer_query به‌دست آید. پارامتر names را روی فهرستی از نام‌های سند (documents/...) تنظیم کن و اسناد منبع معتبر استفاده‌شده در پاسخ نهایی‌ات را ذکر کن.

نمونه کد زیر نحوه استفاده از curl برای فراخوانی ابزار MCP get_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": "get_documents",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

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

طرح‌واره درخواست برای get_documents.

GetDocumentsRequest

نمایش JSON 
{
  "names": [
    string
  ]
}
فیلدها
names[]

string

الزامی. نام اسناد برای بازیابی، همان‌طور که توسط فیلد parent از نتایج search_documents یا فیلد references از answer_query برگردانده شده است. حداکثر ۲۰ سند را می‌توان در یک فراخوانی بازیابی کرد. اسناد با همان ترتیبی که names در درخواست آمده است برگردانده می‌شوند. قالب: documents/{uri_without_scheme} نمونه: documents/docs.cloud.google.com/storage/docs/creating-buckets

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

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

GetDocumentsResponse

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

object (Document)

اسناد درخواست شد.

سند

نمایش JSON 
{
  "name": string,
  "uri": string,
  "content": string,
  "description": string,
  "title": string
}
فیلدها
name

string

شناسه. نام منبع سند. قالب: documents/{uri_without_scheme} نمونه: documents/docs.cloud.google.com/storage/docs/creating-buckets
uri

string

فقط خروجی. ‫URI محتوا، مثلاً https://cloud.google.com/storage/docs/creating-buckets.
content

string

فقط خروجی. محتوای سند در قالب Markdown.
description

string

فقط خروجی. شرح سند.
title

string

فقط خروجی. عنوان سند.

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

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

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

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

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