MCP Tools Reference: classroommcp.googleapis.com

Outil : list_courses

Répertorie les cours de l'utilisateur avec leurs détails (section, salle, matière, niveaux scolaires, description, objectifs d'apprentissage, état et rôle de l'utilisateur). Utilisez-le comme point d'entrée principal pour découvrir des cours et récupérer leurs ID. Les cours partagent souvent un titre. Utilisez donc la section pour les distinguer. Ne renvoie que les cours ACTIFS, sauf si courseState est défini (par exemple, ARCHIVED).

Pour rediriger l'utilisateur vers un cours dans l'application Web Classroom, utilisez https://classroom.google.com/c/{course_id} (flux) ou https://classroom.google.com/w/{course_id}/t/all (page "Travaux et devoirs"). Utilisez les ID exactement tels qu'ils sont renvoyés. Ne les devinez pas et ne les modifiez pas.

L'exemple de code suivant montre comment utiliser curl pour appeler l'outil MCP list_courses.

Requête 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
}'

Schéma d'entrée

Requête permettant de lister les cours.

ListCoursesRequest

Représentation JSON
{
  "courseState": enum (State),
  "createdDateRange": {
    object (DateRange)
  },
  "timeZone": string,
  "titleContains": string,
  "pageSize": integer,
  "pageToken": string
}
Champs
courseState

enum (State)

Facultatif. Filtrer par état du cours. La valeur par défaut est ACTIVE.

createdDateRange

object (DateRange)

Facultatif. Filtrer par plage de dates de création.

timeZone

string

Obligatoire. Fuseau horaire IANA de l'utilisateur (par exemple, "America/Los_Angeles"). Les dates de cette requête sont interprétées dans ce fuseau horaire, et les dates de la réponse sont mises en forme dans ce fuseau horaire, ce qui correspond à ce que l'utilisateur voit dans Classroom.

titleContains

string

Facultatif. Filtrer le titre par sous-chaîne non sensible à la casse.

pageSize

integer

Facultatif. Contrôle la taille de la page. La valeur par défaut est 10, et la valeur maximale est 50.

pageToken

string

Facultatif. Jeton pour la pagination.

DateRange

Représentation JSON
{
  "startDate": string,
  "endDate": string
}
Champs
startDate

string

Début de la plage, inclusif (format : AAAA-MM-JJ).

endDate

string

Fin de la plage (inclusive, format : AAAA-MM-JJ).

État

États d'un cours.

Enums
STATE_UNSPECIFIED État non spécifié.
ACTIVE État actif.
ARCHIVED État archivé.
PROVISIONED État provisionné.

Schéma de sortie

Réponse pour lister les cours.

ListCoursesResponse

Représentation JSON
{
  "courses": [
    {
      object (Course)
    }
  ],
  "nextPageToken": string
}
Champs
courses[]

object (Course)

Liste des cours.

nextPageToken

string

Jeton de la page suivante.

Cours

Représentation 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)
    }
  ]
}
Champs
id

string

Identifiant. Identifiant de ce cours.

title

string

Titre du cours.

role

enum (Role)

Rôle de l'utilisateur dans ce cours.

creationDate

string

Date de création du cours (format : AAAA-MM-JJ). Vide si la date de création n'est pas connue.

state

enum (State)

Uniquement en sortie. État du cours.

section

string

Facultatif. section du cours.

room

string

Facultatif. Salle du cours.

subject

string

Facultatif. Sujet du cours.

gradeLevels

string

Facultatif. Niveaux scolaires du cours.

description

string

Facultatif. Description du cours.

learningGoals[]

object (LearningGoal)

Uniquement en sortie. Objectifs d'apprentissage associés à ce cours.

LearningGoal

Représentation JSON
{
  "id": string,
  "type": enum (Type),
  "standardCode": string,
  "title": string,
  "documentTitle": string
}
Champs
id

string

Uniquement en sortie. ID de l'objectif d'apprentissage. Pour associer un standard, utilisez un id de search_course_standards (et non standardCode).

type

enum (Type)

Uniquement en sortie. Type d'objectif d'apprentissage.

standardCode

string

Uniquement en sortie. Code standard (par exemple, "NY-2.NBT.4"). Renseigné uniquement pour les normes.

title

string

Uniquement en sortie. Description de l'instruction pour les normes ou titre lisible par l'humain pour les compétences.

documentTitle

string

Uniquement en sortie. Nom du document du programme. Renseigné uniquement pour les normes.

Rôle

Rôles d'un utilisateur dans un cours.

Enums
ROLE_UNSPECIFIED Rôle non spécifié.
TEACHER Rôle "Enseignant".
COTEACHER Rôle "Co-enseignant".
STUDENT Rôle "Élève".
INVITED_OR_INACTIVE Rôle invité ou inactif.

État

États d'un cours.

Enums
STATE_UNSPECIFIED État non spécifié.
ACTIVE État actif.
ARCHIVED État archivé.
PROVISIONED État provisionné.

Type

Type d'objectif d'apprentissage.

Enums
TYPE_UNSPECIFIED Type d'objectif d'apprentissage non spécifié.
STANDARD Norme d'apprentissage d'un programme scolaire.
SKILL Compétence représentant un concept ou une compétence pédagogique. Seul un enseignant peut ajouter ou supprimer des compétences dans Classroom.

Annotations d'outils

Les annotations d'outil sont envoyées aux clients MCP pour décrire le risque de base d'un outil donné. La plupart des clients considèrent ces indications comme non fiables, mais elles peuvent être utilisées pour décider quand envoyer une invite de confirmation à un utilisateur.

En plus de la chaîne de titre, les indications booléennes suivantes sont définies comme suit :

  • readOnlyHint : si la valeur est "true", l'outil ne modifie pas son environnement. Valeur par défaut : "false".
  • destructiveHint : si la valeur est "true", l'outil peut effectuer des actions destructrices. Si la valeur est "false", l'outil ne peut effectuer que des actions d'ajout. Valeur par défaut : "true".
  • idempotentHint : si la valeur est "true", l'appel répété de l'outil avec les mêmes arguments n'aura aucun effet supplémentaire sur son environnement. Valeur par défaut : "false".
  • openWorldHint : si la valeur est "true", l'outil peut interagir avec un "monde ouvert" d'entités externes. Si la valeur est "false", l'outil ne peut interagir qu'avec des entités internes. Par exemple, un outil de recherche sur le Web serait en monde ouvert, tandis qu'un outil de mémoire ne le serait pas.

Indication de destruction : ❌ | Indication d'idempotence : ✅ | Indication de lecture seule : ✅ | Indication en monde ouvert : ❌

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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