MCP Tools Reference: classroommcp.googleapis.com

工具:get_announcements

按 ID 检索课程中一个或多个通知的完整文本、附加材料、受托人和状态。使用 list_announcement_summaries 发现通告并检索其 ID。

以下代码示例展示了如何使用 curl 调用 get_announcements MCP 工具。

Curl 请求
curl --location 'https://classroommcp.googleapis.com/mcp/v1' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "get_announcements",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

输入架构

请求获取通知详情。

GetAnnouncementsRequest

JSON 表示法
{
  "courseId": string,
  "announcementIds": [
    string
  ],
  "timeZone": string
}
字段
courseId

string

必需。课程的标识符。

announcementIds[]

string

必需。通知的标识符。每个请求最多 50 个 ID。

timeZone

string

必需。用户的 IANA 时区(例如 "America/Los_Angeles")。此请求中的日期会按该时区进行解读,响应中的日期会按该时区进行格式化,与用户在 Google 课堂中看到的日期一致。

输出架构

包含通告详情的响应。

GetAnnouncementsResponse

JSON 表示法
{
  "announcements": [
    {
      object (Announcement)
    }
  ]
}
字段
announcements[]

object (Announcement)

检索到的通知列表。

通知

JSON 表示法
{
  "id": string,
  "materials": [
    {
      object (Material)
    }
  ],
  "assigneeIds": [
    string
  ],
  "publishDate": string,
  "state": enum (State),
  "text": string,
  "scheduleDate": string
}
字段
id

string

仅限输出。标识符。公告 ID。

materials[]

object (Material)

此通知中附加的资料。

assigneeIds[]

string

可以看到此通知的学生 ID 列表(未设置表示所有学生)。

publishDate

string

仅限输出。公告发布日期 (YYYY-MM-DD)。

state

enum (State)

仅限输出。通知的状态。

text

string

通知的文本。

scheduleDate

string

公告的预定发布日期 (YYYY-MM-DD)。时间默认为用户所在时区的上午 8 点,可在界面中修改。

材质

JSON 表示法
{
  "id": string,

  "sharedDriveFile": {
    object (SharedDriveFile)
  },
  "youtubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  },
  "notebook": {
    object (GeminiNotebook)
  }
}
字段
id

string

仅限输出。材料的标识符。使用 UpdateCourseWorkRequest.removeMaterialIds 移除材料。

联合字段 content。附件内容。content 只能是下列其中一项:
sharedDriveFile

object (SharedDriveFile)

Google 云端硬盘文件附件。

youtubeVideo

object (YouTubeVideo)

YouTube 视频附件。

link

object (Link)

网址链接附件。

form

object (Form)

Google 表单附件。

notebook

object (GeminiNotebook)

Gemini Notebook 附件。

SharedDriveFile

JSON 表示法
{
  "file": {
    object (DriveFile)
  },
  "shareMode": enum (ShareMode)
}
字段
file

object (DriveFile)

云端硬盘文件详细信息。

shareMode

enum (ShareMode)

必需。学生获取文件的方式:查看(只读)、编辑(所有人编辑同一文件)或复制(每位学生都会获得自己的副本)。

DriveFile

JSON 表示法
{
  "id": string,
  "title": string,
  "url": string
}
字段
id

string

必需。云端硬盘文件的标识符。

title

string

仅限输出。云端硬盘文件的标题。

url

string

仅限输出。云端硬盘文件的网址。

YouTubeVideo

JSON 表示法
{
  "id": string,
  "title": string
}
字段
id

string

必需。YouTube 视频 ID。

title

string

仅限输出。YouTube 视频的标题。

JSON 表示法
{
  "url": string,
  "title": string
}
字段
url

string

必需。链接的网址。

title

string

仅限输出。链接的标题。

表单

JSON 表示法
{
  "formUrl": string,
  "title": string,
  "responseUrl": string
}
字段
formUrl

string

必需。表单的网址。

title

string

仅限输出。表单的标题。

responseUrl

string

仅限输出。表单回复的网址。仅在已记录回复且请求用户是表单的编辑者时设置。

GeminiNotebook

JSON 表示法
{
  "id": string,
  "title": string
}
字段
id

string

必需。Notebook 的标识符。

title

string

笔记本的标题。

ShareMode

云端硬盘文件的共享设置。

枚举
SHARE_MODE_UNSPECIFIED 未指定共享模式。
VIEW 学生可以查看共享的文件。
EDIT 学生可以编辑共享文件。
COPY 学生会收到共享文件的个人副本。

州

通知的状态。

枚举
STATE_UNSPECIFIED 未指定状态。
PUBLISHED 通知已发布,学生可以看到。
DRAFT 通知为草稿。

工具注释

工具注解会发送到 MCP 客户端,用于描述给定工具的基本风险。大多数客户端会将这些提示视为不可信,但它们可用于决定何时向用户发送确认提示。

除了标题字符串之外,还定义了以下布尔值提示:

  • readOnlyHint:如果为 true,则该工具不会修改其环境。默认值:false。
  • destructiveHint:如果为 true,则该工具可以执行破坏性操作。如果为 false,则该工具只能执行添加操作。默认值:true。
  • idempotentHint:如果为 true,则使用相同参数重复调用该工具不会对其环境产生额外影响。默认值:false。
  • openWorldHint:如果为 true,则该工具可以与外部实体的“开放世界”进行交互。如果为 false,则该工具只能与内部实体交互。例如,网页搜索工具是开放式的,而记忆工具不是开放式的。

破坏性提示:❌ | 等幂性提示:✅ | 只读提示:✅ | 开放世界提示:❌

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/classroom.announcements
  • https://www.googleapis.com/auth/classroom.announcements.readonly