MCP Tools Reference: classroommcp.googleapis.com

Инструмент: list_courses

Показывает список курсов пользователя с подробными сведениями (раздел, аудитория, предмет, классы, описание, учебные цели, статус и роль пользователя). Используйте его как основную точку входа для поиска курсов и получения их идентификаторов. У курсов часто бывают одинаковые названия, поэтому используйте разделы, чтобы различать их. Возвращает только активные курсы, если не задан параметр courseState (например, ARCHIVED).

Чтобы направить пользователя на курс в веб-приложении Класса, используйте https://classroom.google.com/c/{course_id} (лента) или https://classroom.google.com/w/{course_id}/t/all (страница "Задания"). Используйте идентификаторы в том виде, в котором они возвращаются. Не пытайтесь угадать или изменить их.

В примере кода ниже показано, как использовать curl для вызова инструмента MCP list_courses.

Запрос 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": "list_courses",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Схема ввода

Запрос на получение списка курсов.

ListCoursesRequest

JSON-представление
{
  "courseState": enum (State),
  "createdDateRange": {
    object (DateRange)
  },
  "timeZone": string,
  "titleContains": string,
  "pageSize": integer,
  "pageToken": string
}
Поля
courseState

enum (State)

Необязательное поле. Фильтровать по статусу курса. Значение по умолчанию – ACTIVE.

createdDateRange

object (DateRange)

Необязательное поле. Фильтр по диапазону дат создания.

timeZone

string

Обязательно. Часовой пояс пользователя по классификации IANA (например, "America/Los_Angeles"). Даты в запросе и ответе интерпретируются и форматируются в соответствии с ним, чтобы пользователь видел их в Классе в правильном формате.

titleContains

string

Необязательное поле. Фильтрация по названию с использованием подстроки без учета регистра.

pageSize

integer

Необязательное поле. Управляет размером страницы. Значение по умолчанию – 10, максимальное – 50.

pageToken

string

Необязательное поле. Токен для разбивки на страницы.

DateRange

JSON-представление
{
  "startDate": string,
  "endDate": string
}
Поля
startDate

string

Начало диапазона (включая указанную дату в формате ГГГГ-ММ-ДД).

endDate

string

Конец диапазона (формат: ГГГГ-ММ-ДД).

Штат

Статусы курса.

Перечисления
STATE_UNSPECIFIED Состояние не указано.
ACTIVE Активное состояние.
ARCHIVED Архив.
PROVISIONED Состояние инициализации.

Схема вывода

Ответ на запрос списка курсов.

ListCoursesResponse

JSON-представление
{
  "courses": [
    {
      object (Course)
    }
  ],
  "nextPageToken": string
}
Поля
courses[]

object (Course)

Список курсов.

nextPageToken

string

Токен следующей страницы.

Курс

JSON-представление
{
  "id": string,
  "title": string,
  "role": enum (Role),
  "creationDate": string,
  "state": enum (State),
  "section": string,
  "room": string,
  "subject": string,
  "gradeLevels": string,
  "description": string,
  "learningGoals": [
    {
      object (LearningGoal)
    }
  ]
}
Поля
id

string

Идентификатор. Идентификатор курса.

title

string

Название курса.

role

enum (Role)

Роль пользователя на этом курсе.

creationDate

string

Дата создания курса (формат: ГГГГ-ММ-ДД). Если дата создания неизвестна, поле остается пустым.

state

enum (State)

Только для вывода. Статус курса.

section

string

Необязательное поле. Раздел курса.

room

string

Необязательное поле. Аудитория, в которой проводится курс.

subject

string

Необязательное поле. Тема курса.

gradeLevels

string

Необязательное поле. Классы обучения, для которых предназначен курс.

description

string

Необязательное поле. Описание курса.

learningGoals[]

object (LearningGoal)

Только для вывода. Учебные цели, прикрепленные к этому курсу.

LearningGoal

JSON-представление
{
  "id": string,
  "type": enum (Type),
  "standardCode": string,
  "title": string,
  "documentTitle": string
}
Поля
id

string

Только для вывода. Идентификатор учебной цели. Чтобы прикрепить стандарт, используйте id из search_course_standards (не standardCode).

type

enum (Type)

Только для вывода. Тип учебной цели.

standardCode

string

Только для вывода. Стандартный код (например, "NY-2.NBT.4"). Заполняется только для стандартов.

title

string

Только для вывода. Описание утверждения для стандартов или человекочитаемое название для навыков.

documentTitle

string

Только для вывода. Название документа с учебным планом. Заполняется только для стандартов.

Роль

Роли пользователя в курсе.

Перечисления
ROLE_UNSPECIFIED Роль не указана.
TEACHER Роль преподавателя.
COTEACHER Роль приглашенного преподавателя.
STUDENT Роль учащегося.
INVITED_OR_INACTIVE Приглашенный или неактивный пользователь.

Штат

Статусы курса.

Перечисления
STATE_UNSPECIFIED Состояние не указано.
ACTIVE Активное состояние.
ARCHIVED Архив.
PROVISIONED Состояние инициализации.

Тип

Тип учебной цели.

Перечисления
TYPE_UNSPECIFIED Тип учебной цели не указан.
STANDARD Образовательный стандарт из учебной программы.
SKILL Навык, представляющий собой образовательную концепцию или компетенцию. Добавлять и удалять навыки в Классе могут только преподаватели.

Аннотации инструментов

Аннотации инструментов отправляются клиентам MCP, чтобы описать основные риски, связанные с определенным инструментом. Большинство клиентов считают эти подсказки ненадежными, но их можно использовать, чтобы решить, когда пользователю может быть отправлен запрос на подтверждение.

Помимо строки заголовка, определены следующие логические подсказки:

  • readOnlyHint: если задано значение true, инструмент не изменяет свою среду. Значение по умолчанию – false.
  • destructiveHint: если задано значение True, инструмент может выполнять деструктивные действия. Если false, то инструмент может выполнять только действия по добавлению. Значение по умолчанию: true.
  • idempotentHint. Если задано значение True, повторный вызов инструмента с теми же аргументами не будет иметь дополнительного эффекта. Значение по умолчанию – false.
  • openWorldHint: если задано значение true, инструмент может взаимодействовать с "открытым миром" внешних объектов. Если false, то инструмент может взаимодействовать только с внутренними объектами. Например, инструмент веб-поиска будет открытым миром, а инструмент памяти – нет.

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

Области авторизации

Требует одной из следующих областей применения OAuth:

  • https://www.googleapis.com/auth/classroom.courses.readonly
  • https://www.googleapis.com/auth/classroom.rosters.readonly