MCP Tools Reference: developerknowledge.googleapis.com

ابزار: get_documents

از این ابزار برای بازیابی محتوای کامل یک سند یا حداکثر ۲۰ سند در یک فراخوانی واحد استفاده کنید. نام اسناد باید از فیلد parent نتایج حاصل از فراخوانی ابزار search_documents به دست آید. پارامتر names را روی لیستی از نام اسناد تنظیم کنید.

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

درخواست کرل
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 tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

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

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

درخواست دریافت اسناد

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

string

الزامی. نام اسنادی که باید بازیابی شوند، همانطور که توسط search_documents برگردانده شده است. حداکثر 20 سند را می‌توان در یک فراخوانی بازیابی کرد. اسناد به همان ترتیب 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 : اگر درست باشد، ابزار محیط خود را تغییر نمی‌دهد. پیش‌فرض: نادرست.
  • destructiveHint : اگر درست باشد، ابزار می‌تواند اقدامات مخرب انجام دهد. اگر نادرست باشد، ابزار فقط می‌تواند اقدامات افزایشی انجام دهد. پیش‌فرض: درست.
  • idempotentHint : اگر مقدار آن درست باشد، فراخوانی مکرر ابزار با آرگومان‌های یکسان، هیچ تأثیر اضافی بر محیط آن نخواهد داشت. پیش‌فرض: false.
  • openWorldHint : اگر درست باشد، ابزار می‌تواند با «دنیای باز» از موجودیت‌های خارجی تعامل داشته باشد. اگر نادرست باشد، ابزار فقط می‌تواند با موجودیت‌های داخلی تعامل داشته باشد. برای مثال، یک ابزار جستجوی وب جهان‌باز خواهد بود، در حالی که یک ابزار حافظه جهان‌باز نخواهد بود.

راهنمایی مخرب: ❌ | راهنمایی بی‌اثر: ✅ | راهنمایی فقط خواندنی: ✅ | راهنمایی جهان باز: ❌