MCP Tools Reference: docsmcp.googleapis.com

ابزار: update_doc

یک سند را با استفاده از درخواست‌های به‌روزرسانی دسته‌ای به‌روزرسانی می‌کند. این تابع درخواست documents.batchUpdate (به صورت JSON) را می‌پذیرد.

معادل documents.batchUpdate در REST API است.

لیست به‌روزرسانی‌های احتمالی به شرح زیر است:

  • replaceAllText : تمام نمونه‌های متن مشخص شده را جایگزین می‌کند.
  • insertText : متن را در محل مشخص شده درج می‌کند.
  • updateTextStyle : استایل متن را در محدوده مشخص شده به‌روزرسانی می‌کند.
  • createParagraphBullets : برای پاراگراف‌ها، بولت ایجاد می‌کند.
  • deleteParagraphBullets : بولت‌ها را از پاراگراف‌ها حذف می‌کند.
  • createNamedRange : یک محدوده نامگذاری شده ایجاد می‌کند.
  • deleteNamedRange : یک محدوده نامگذاری شده را حذف می‌کند.
  • updateParagraphStyle : استایل پاراگراف را در محدوده مشخص شده به‌روزرسانی می‌کند.
  • deleteContentRange : محتوا را از سند حذف می‌کند.
  • insertInlineImage : یک تصویر درون‌خطی را در مکان مشخص‌شده درج می‌کند.
  • insertTable : یک جدول را در محل مشخص شده درج می‌کند.
  • insertTableRow : یک ردیف خالی در جدول درج می‌کند.
  • insertTableColumn : یک ستون خالی را در جدول درج می‌کند.
  • deleteTableRow : یک سطر از جدول را حذف می‌کند.
  • deleteTableColumn : یک ستون از جدول را حذف می‌کند.
  • insertPageBreak : یک شکست صفحه در محل مشخص شده وارد می‌کند.
  • deletePositionedObject : یک شیء موقعیت‌یابی‌شده را از سند حذف می‌کند.
  • updateTableColumnProperties : ویژگی‌های ستون‌های یک جدول را به‌روزرسانی می‌کند.
  • updateTableCellStyle : استایل سلول‌های جدول را به‌روزرسانی می‌کند.
  • updateTableRowStyle : استایل سطرها را در یک جدول به‌روزرسانی می‌کند.
  • replaceImage : یک تصویر را در سند جایگزین می‌کند.
  • updateDocumentStyle : استایل سند را به‌روزرسانی می‌کند.
  • insertInlineSheetsChart : یک نمودار درون‌خطی Google Sheets را در مکان مشخص‌شده درج می‌کند.
  • mergeTableCells : سلول‌های یک جدول را ادغام می‌کند.
  • unmergeTableCells : سلول‌های یک جدول را از حالت ادغام خارج می‌کند.
  • refreshSheetsChart : نمودار Google Sheets را به‌روزرسانی می‌کند.
  • createHeader : یک سربرگ ایجاد می‌کند.
  • createFooter : یک پاورقی ایجاد می‌کند.
  • createFootnote : یک پاورقی ایجاد می‌کند.
  • replaceNamedRangeContent : محتوای یک محدوده نامگذاری شده را جایگزین می‌کند.
  • updateEmbeddedObject : ویژگی‌های یک شیء جاسازی‌شده را به‌روزرسانی می‌کند.
  • updateSectionStyle : استایل بخش مربوط به محدوده‌ی مشخص‌شده را به‌روزرسانی می‌کند.
  • insertSectionBreak : یک بخش جدید در محل مشخص شده درج می‌کند.
  • deleteHeader : یک سربرگ را از سند حذف می‌کند.
  • deleteFooter : یک پاورقی را از سند حذف می‌کند.
  • pinTableHeaderRows : تعداد سطرهای سربرگ پین‌شده در یک جدول را به‌روزرسانی می‌کند.
  • addDocumentTab : یک تب سند اضافه می‌کند.
  • deleteTab : یک تب سند را حذف می‌کند.
  • updateDocumentTabProperties : ویژگی‌های یک تب سند را به‌روزرسانی می‌کند.
  • insertPerson : اشاره به یک شخص را درج می‌کند.
  • updateNamedStyle : یک استایل نامگذاری شده را به‌روزرسانی می‌کند.
  • insertRichLink : یک لینک غنی درج می‌کند.
  • insertDate : یک تاریخ درج می‌کند.
  • insertComment : یک CommentThread را در سند درج می‌کند.
  • addCommentReply : پاسخی را به CommentThread یا SuggestionThread اضافه می‌کند.
  • updateCommentPost : یک پست موجود (پست اصلی یا پاسخ) از یک CommentThread یا SuggestionThread را به‌روزرسانی می‌کند.
  • deleteComment : یک رشته نظر را حذف می‌کند.
  • deleteCommentReply : یک پست پاسخ داده شده را از یک CommentThread یا SuggestionThread حذف می‌کند.
  • acceptSuggestion : یک پیشنهاد را می‌پذیرد.
  • rejectSuggestion : یک پیشنهاد را رد می‌کند.
  • deleteSuggestion : یک پیشنهاد را حذف می‌کند.

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

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

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

درخواست به‌روزرسانی سند

نمایش JSON 
{
  "documentId": string,
  "requests": [
    {
      object
    }
  ]
}
فیلدها
documentId

string

الزامی. شناسه سندی که باید به‌روزرسانی شود. این همان شناسه فایل از ابزارهای Drive است.

requests[]

object ( Struct format)

فهرستی از به‌روزرسانی‌ها برای اعمال به سند. هر درخواست باید یک شیء درخواست document.batchUpdate معتبر باشد که از طرحواره مستند شده در: https://developers.google.com/workspace/docs/api/reference/rest/v1/documents/request استفاده می‌کند. درخواست‌ها به ترتیبی که مشخص شده‌اند اعمال خواهند شد. اگر هر درخواستی معتبر نباشد، هیچ درخواستی اعمال نخواهد شد.

ساختار

نمایش JSON 
{
  "fields": {
    string: value,
    ...
  }
}
فیلدها
fields

map (key: string, value: value ( Value format))

نقشه نامرتب از مقادیر با نوع پویا.

یک شیء شامل لیستی از جفت‌های "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

فیلدهاورود

نمایش JSON 
{
  "key": string,
  "value": value
}
فیلدها
key

string

value

value ( Value format)

ارزش

نمایش JSON 
{

  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
}
فیلدها
فیلد Union kind . نوع مقدار. kind فقط می‌تواند یکی از موارد زیر باشد:
nullValue

null

نشان دهنده یک JSON null .

numberValue

number

نشان دهنده یک عدد JSON است. نباید NaN ، Infinity یا -Infinity باشد، زیرا این موارد در JSON پشتیبانی نمی‌شوند. این همچنین نمی‌تواند مقادیر بزرگ Int64 را نشان دهد، زیرا فرمت JSON معمولاً از آنها در نوع عدد خود پشتیبانی نمی‌کند.

stringValue

string

نشان دهنده یک رشته JSON است.

boolValue

boolean

نشان دهنده یک مقدار بولی JSON (در JSON، مقدار حقیقی یا مجازی true یا false ) است.

structValue

object ( Struct format)

نشان دهنده یک شیء JSON است.

listValue

array ( ListValue format)

نشان دهنده یک آرایه JSON است.

مقدار لیست

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

value ( Value format)

فیلد تکراری با مقادیر تایپ‌شده‌ی پویا.

مقدار تهی

نشان دهنده یک JSON null .

NullValue یک نگهبان است که از یک enum با تنها یک مقدار برای نمایش مقدار null برای نوع Value استفاده می‌کند.

فیلدی از نوع NullValue با هر مقداری غیر از 0 نامعتبر در نظر گرفته می‌شود. اکثر سریالایزرهای ProtoJSON صرف نظر از مقدار صحیح، Value با null_value که به عنوان JSON null تنظیم شده است، منتشر می‌کنند و بنابراین به صورت رفت و برگشتی به مقدار 0 می‌رسند.

انوم‌ها
NULL_VALUE مقدار تهی.

طرحواره خروجی

پاسخ UpdateDoc

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

object ( Struct format)

پاسخ‌های حاصل از اجرای درخواست‌های به‌روزرسانی دسته‌ای. شامل خطاها، هشدارها و پاسخ‌های خام API برای کمک به مدل در انجام تنظیمات. پاسخ‌های خام API از طرحواره‌ای که در آدرس زیر مستند شده است، استفاده می‌کنند: https://developers.google.com/workspace/docs/api/reference/rest/v1/documents/response

ساختار

نمایش JSON 
{
  "fields": {
    string: value,
    ...
  }
}
فیلدها
fields

map (key: string, value: value ( Value format))

نقشه نامرتب از مقادیر با نوع پویا.

یک شیء شامل لیستی از جفت‌های "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

فیلدهاورود

نمایش JSON 
{
  "key": string,
  "value": value
}
فیلدها
key

string

value

value ( Value format)

ارزش

نمایش JSON 
{

  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
}
فیلدها
فیلد Union kind . نوع مقدار. kind فقط می‌تواند یکی از موارد زیر باشد:
nullValue

null

نشان دهنده یک JSON null .

numberValue

number

نشان دهنده یک عدد JSON است. نباید NaN ، Infinity یا -Infinity باشد، زیرا این موارد در JSON پشتیبانی نمی‌شوند. این همچنین نمی‌تواند مقادیر بزرگ Int64 را نشان دهد، زیرا فرمت JSON معمولاً از آنها در نوع عدد خود پشتیبانی نمی‌کند.

stringValue

string

نشان دهنده یک رشته JSON است.

boolValue

boolean

نشان دهنده یک مقدار بولی JSON (در JSON، مقدار حقیقی یا مجازی true یا false ) است.

structValue

object ( Struct format)

نشان دهنده یک شیء JSON است.

listValue

array ( ListValue format)

نشان دهنده یک آرایه JSON است.

مقدار لیست

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

value ( Value format)

فیلد تکراری با مقادیر تایپ‌شده‌ی پویا.

مقدار تهی

نشان دهنده یک JSON null .

NullValue یک نگهبان است که از یک enum با تنها یک مقدار برای نمایش مقدار null برای نوع Value استفاده می‌کند.

فیلدی از نوع NullValue با هر مقداری غیر از 0 نامعتبر در نظر گرفته می‌شود. اکثر سریالایزرهای ProtoJSON صرف نظر از مقدار صحیح، Value با null_value که به عنوان JSON null تنظیم شده است، منتشر می‌کنند و بنابراین به صورت رفت و برگشتی به مقدار 0 می‌رسند.

انوم‌ها
NULL_VALUE مقدار تهی.

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

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