MCP Tools Reference: classroommcp.googleapis.com

Narzędzie: list_courses

Wyświetla listę zajęć użytkownika wraz ze szczegółowymi informacjami (sekcja, sala, przedmiot, poziomy nauczania, opis, cele edukacyjne, stan i rola użytkownika). Używaj tego jako głównego punktu wejścia do odkrywania kursów i pobierania ich identyfikatorów. Zajęcia często mają ten sam tytuł, więc użyj sekcji, aby je odróżnić. Zwraca tylko AKTYWNE zajęcia, chyba że ustawiono parametr courseState (np. ARCHIVED).

Aby przekierować użytkownika do zajęć w aplikacji internetowej Classroom, użyj adresu https://classroom.google.com/c/{course_id} (strumień) lub https://classroom.google.com/w/{course_id}/t/all (strona Zadania). Używaj identyfikatorów dokładnie w takiej postaci, w jakiej zostały zwrócone. Nigdy ich nie zgaduj ani nie modyfikuj.

Poniższy przykładowy kod pokazuje, jak używać curl do wywoływania narzędzia MCP list_courses.

Żądanie 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
}'

Schemat wejściowy

Żądanie wyświetlenia listy zajęć.

ListCoursesRequest

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

enum (State)

Opcjonalnie: Filtruj według stanu zajęć. Domyślna wartość to ACTIVE.

createdDateRange

object (DateRange)

Opcjonalnie: Filtruj według zakresu dat utworzenia.

timeZone

string

Wymagane. Strefa czasowa IANA użytkownika (np. "America/Los_Angeles"). Daty w tym żądaniu są interpretowane w tej strefie czasowej, a daty w odpowiedzi są sformatowane w tej strefie czasowej, zgodnie z tym, co użytkownik widzi w Classroom.

titleContains

string

Opcjonalnie: Filtruj tytuł według podłańcucha, wielkość liter nie jest rozróżniana.

pageSize

integer

Opcjonalnie: Określa rozmiar strony. Domyślna wartość to 10, a maksymalna – 50.

pageToken

string

Opcjonalnie: Token podziału na strony.

Zakres dat

Zapis JSON
{
  "startDate": string,
  "endDate": string
}
Pola
startDate

string

Początek zakresu (włącznie, format: RRRR-MM-DD).

endDate

string

Koniec zakresu (format: RRRR-MM-DD).

Stan

Stany kursu.

Wartości w polu enum
STATE_UNSPECIFIED Stan nieokreślony.
ACTIVE Stan aktywny.
ARCHIVED Stan zarchiwizowania.
PROVISIONED Stan obsługi administracyjnej.

Schemat wyjściowy

Odpowiedź na prośbę o wyświetlenie listy zajęć.

ListCoursesResponse

Zapis JSON
{
  "courses": [
    {
      object (Course)
    }
  ],
  "nextPageToken": string
}
Pola
courses[]

object (Course)

Lista kursów.

nextPageToken

string

Token następnej strony.

Kurs

Zapis 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)
    }
  ]
}
Pola
id

string

Identyfikator. Identyfikator tych zajęć.

title

string

Tytuł kursu.

role

enum (Role)

Rola użytkownika na tych zajęciach.

creationDate

string

Data utworzenia kursu (format: RRRR-MM-DD). Jeśli data utworzenia jest nieznana, pole jest puste.

state

enum (State)

Tylko dane wyjściowe. Stan kursu.

section

string

Opcjonalnie: Sekcja kursu.

room

string

Opcjonalnie: Sala, w której odbywają się zajęcia.

subject

string

Opcjonalnie: Temat kursu.

gradeLevels

string

Opcjonalnie: Poziomy nauczania kursu.

description

string

Opcjonalnie: Opis kursu.

learningGoals[]

object (LearningGoal)

Tylko dane wyjściowe. Cele edukacyjne dołączone do tego kursu.

LearningGoal

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

string

Tylko dane wyjściowe. Identyfikator celu edukacyjnego. Aby dołączyć standard, użyj id z search_course_standards (nie standardCode).

type

enum (Type)

Tylko dane wyjściowe. Typ celu edukacyjnego.

standardCode

string

Tylko dane wyjściowe. Kod standardu (np. „NY-2.NBT.4”). Wartość jest podawana tylko w przypadku standardów.

title

string

Tylko dane wyjściowe. Opis oświadczenia dotyczącego standardów lub zrozumiały dla człowieka tytuł dotyczący umiejętności.

documentTitle

string

Tylko dane wyjściowe. Nazwa dokumentu programu nauczania. Wartość jest podawana tylko w przypadku standardów.

Rola

Role użytkownika na zajęciach.

Wartości w polu enum
ROLE_UNSPECIFIED Nieokreślona rola.
TEACHER Rola nauczyciela.
COTEACHER Rola nauczyciela współprowadzącego.
STUDENT Rola ucznia.
INVITED_OR_INACTIVE Zaproszona lub nieaktywna rola.

Stan

Stany kursu.

Wartości w polu enum
STATE_UNSPECIFIED Stan nieokreślony.
ACTIVE Stan aktywny.
ARCHIVED Stan zarchiwizowania.
PROVISIONED Stan obsługi administracyjnej.

Typ

Typ celu edukacyjnego.

Wartości w polu enum
TYPE_UNSPECIFIED Nieokreślony typ celu edukacyjnego.
STANDARD Standard nauczania z programu akademickiego.
SKILL Umiejętność reprezentująca koncepcję lub kompetencję edukacyjną. Tylko nauczyciel może dodawać i usuwać umiejętności w Classroom.

Adnotacje dotyczące narzędzi

Adnotacje narzędzia są wysyłane do klientów MCP, aby opisać podstawowe ryzyko związane z danym narzędziem. Większość klientów traktuje te wskazówki jako niezaufane, ale można ich użyć do określenia, kiedy wysłać użytkownikowi prośbę o potwierdzenie.

Oprócz ciągu tytułu zdefiniowane są te wskazówki logiczne:

  • readOnlyHint: jeśli ma wartość „true”, narzędzie nie modyfikuje swojego środowiska. Wartość domyślna: false.
  • destructiveHint: jeśli ma wartość „true”, narzędzie może wykonywać działania destrukcyjne. Jeśli ma wartość false, narzędzie może wykonywać tylko działania dodawania. Wartość domyślna: true.
  • idempotentHint: jeśli ma wartość „true”, wielokrotne wywoływanie narzędzia z tymi samymi argumentami nie będzie miało dodatkowego wpływu na jego środowisko. Wartość domyślna: false.
  • openWorldHint: jeśli ma wartość true, narzędzie może wchodzić w interakcje z „otwartym światem” podmiotów zewnętrznych. Jeśli ma wartość false, narzędzie może wchodzić w interakcje tylko z elementami wewnętrznymi. Na przykład narzędzie do wyszukiwania w internecie jest narzędziem typu Otwarty świat, a narzędzie do zapamiętywania – nie.

Wskazówka dotycząca destrukcyjności: ❌ | Wskazówka dotycząca idempotencji: ✅ | Wskazówka dotycząca tylko do odczytu: ✅ | Wskazówka dotycząca otwartego świata: ❌

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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