MCP Tools Reference: classroommcp.googleapis.com

Alat: list_courses

Mencantumkan kursus pengguna beserta detailnya (bagian, ruang, mata pelajaran, tingkat kelas, deskripsi, sasaran pembelajaran, status, dan peran pengguna). Gunakan ini sebagai titik entri utama untuk menemukan kursus dan mengambil ID-nya. Kursus sering kali memiliki judul yang sama, jadi gunakan bagian untuk membedakannya. Hanya menampilkan kursus ACTIVE kecuali jika courseState ditetapkan (misalnya, ARCHIVED).

Untuk menautkan pengguna ke kursus di aplikasi web Classroom, gunakan https://classroom.google.com/c/{course_id} (forum) atau https://classroom.google.com/w/{course_id}/t/all (halaman Tugas kelas). Gunakan ID persis seperti yang ditampilkan; jangan pernah menebak atau mengubahnya.

Contoh kode berikut menunjukkan cara menggunakan curl untuk memanggil alat MCP list_courses.

Permintaan 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
}'

Skema Input

Permintaan untuk mencantumkan kursus.

ListCoursesRequest

Representasi JSON
{
  "courseState": enum (State),
  "createdDateRange": {
    object (DateRange)
  },
  "timeZone": string,
  "titleContains": string,
  "pageSize": integer,
  "pageToken": string
}
Kolom
courseState

enum (State)

Opsional. Memfilter menurut status kursus. Default-nya adalah ACTIVE.

createdDateRange

object (DateRange)

Opsional. Filter menurut rentang tanggal pembuatan.

timeZone

string

Wajib. Zona waktu IANA pengguna (misalnya, "America/Los_Angeles"). Tanggal dalam permintaan ini ditafsirkan di dalamnya dan tanggal dalam respons diformat di dalamnya, sesuai dengan yang dilihat pengguna di Classroom.

titleContains

string

Opsional. Memfilter judul menurut substring yang tidak peka huruf besar/kecil.

pageSize

integer

Opsional. Mengontrol ukuran halaman. Default-nya adalah 10; maksimum 50.

pageToken

string

Opsional. Token untuk penomoran halaman.

DateRange

Representasi JSON
{
  "startDate": string,
  "endDate": string
}
Kolom
startDate

string

Awal rentang inklusif (format: YYYY-MM-DD).

endDate

string

Akhir rentang inklusif (format: YYYY-MM-DD).

Negara Bagian

Status kursus.

Enum
STATE_UNSPECIFIED Status tidak ditentukan.
ACTIVE Status aktif.
ARCHIVED Status diarsipkan.
PROVISIONED Status yang disediakan.

Skema Output

Respons untuk mencantumkan kursus.

ListCoursesResponse

Representasi JSON
{
  "courses": [
    {
      object (Course)
    }
  ],
  "nextPageToken": string
}
Kolom
courses[]

object (Course)

Daftar kursus.

nextPageToken

string

Token halaman berikutnya.

Kursus

Representasi 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)
    }
  ]
}
Kolom
id

string

ID. ID untuk kursus ini.

title

string

Judul kursus.

role

enum (Role)

Peran pengguna dalam kursus ini.

creationDate

string

Tanggal pembuatan kursus (format: YYYY-MM-DD). Kosong jika tanggal pembuatan tidak diketahui.

state

enum (State)

Hanya output. Status kursus.

section

string

Opsional. Bagian kursus.

room

string

Opsional. Ruang kursus.

subject

string

Opsional. Subjek kursus.

gradeLevels

string

Opsional. Tingkat kelas kursus.

description

string

Opsional. Deskripsi kursus.

learningGoals[]

object (LearningGoal)

Hanya output. Sasaran pembelajaran yang dilampirkan ke kursus ini.

LearningGoal

Representasi JSON
{
  "id": string,
  "type": enum (Type),
  "standardCode": string,
  "title": string,
  "documentTitle": string
}
Kolom
id

string

Hanya output. ID sasaran pembelajaran. Untuk melampirkan standar, gunakan id dari search_course_standards (bukan standardCode).

type

enum (Type)

Hanya output. Jenis sasaran pembelajaran.

standardCode

string

Hanya output. Kode standar (misalnya, "NY-2.NBT.4"). Hanya diisi untuk standar.

title

string

Hanya output. Deskripsi pernyataan untuk standar, atau judul yang dapat dibaca manusia untuk keterampilan.

documentTitle

string

Hanya output. Nama dokumen kurikulum. Hanya diisi untuk standar.

Peran

Peran pengguna dalam kursus.

Enum
ROLE_UNSPECIFIED Peran tidak ditentukan.
TEACHER Peran pengajar.
COTEACHER Peran rekan pengajar.
STUDENT Peran siswa.
INVITED_OR_INACTIVE Peran yang diundang atau tidak aktif.

Negara Bagian

Status kursus.

Enum
STATE_UNSPECIFIED Status tidak ditentukan.
ACTIVE Status aktif.
ARCHIVED Status diarsipkan.
PROVISIONED Status yang disediakan.

Jenis

Jenis sasaran pembelajaran.

Enum
TYPE_UNSPECIFIED Jenis sasaran pembelajaran belum ditentukan.
STANDARD Standar pembelajaran dari kurikulum akademik.
SKILL Keterampilan yang mewakili konsep atau kompetensi pendidikan. Hanya pengajar yang dapat menambahkan atau menghapus keterampilan di Classroom.

Anotasi Alat

Anotasi alat dikirim ke klien MCP untuk menjelaskan risiko dasar alat tertentu. Sebagian besar klien memperlakukan petunjuk ini sebagai tidak tepercaya, tetapi petunjuk tersebut dapat digunakan untuk memutuskan kapan perintah konfirmasi mungkin dikirim kepada pengguna.

Bersama dengan string judul, petunjuk boolean berikut ditentukan sebagai berikut:

  • readOnlyHint: Jika benar, alat tidak akan mengubah lingkungannya. Default: false.
  • destructiveHint: Jika benar, alat dapat melakukan tindakan destruktif. Jika salah (false), alat hanya dapat melakukan tindakan aditif. Default: true.
  • idempotentHint: Jika benar, memanggil alat berulang kali dengan argumen yang sama tidak akan memberikan efek tambahan pada lingkungannya. Default: false.
  • openWorldHint: Jika benar, alat dapat berinteraksi dengan 'open world' entitas eksternal. Jika salah, alat hanya dapat berinteraksi dengan entity internal. Misalnya, alat penelusuran web akan bersifat open world, sedangkan alat memori tidak akan bersifat open world.

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

Cakupan Otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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