MCP Tools Reference: classroommcp.googleapis.com

टूल: list_courses

इससे उपयोगकर्ता के कोर्स की सूची और उनकी जानकारी दिखती है. जैसे, सेक्शन, कमरा, विषय, ग्रेड लेवल, ब्यौरा, सीखने के लक्ष्य, स्थिति, और उपयोगकर्ता की भूमिका. कोर्स खोजने और उनके आईडी पाने के लिए, इसे मुख्य एंट्री पॉइंट के तौर पर इस्तेमाल करें. कई कोर्स के नाम एक जैसे होते हैं. इसलिए, सेक्शन का इस्तेमाल करके उन्हें अलग-अलग करें. यह सिर्फ़ चालू कोर्स दिखाता है.हालांकि, अगर courseState को सेट किया गया है, तो यह उसके हिसाब से कोर्स दिखाता है. जैसे, ARCHIVED.

Classroom के वेब ऐप्लिकेशन में उपयोगकर्ता को किसी कोर्स से लिंक करने के लिए, https://classroom.google.com/c/{course_id} (स्ट्रीम) या https://classroom.google.com/w/{course_id}/t/all (क्लासवर्क पेज) का इस्तेमाल करें. आईडी को ठीक उसी तरह इस्तेमाल करें जिस तरह वे दिखाए गए हैं. उनमें कभी भी बदलाव न करें या उनका अनुमान न लगाएं.

यहां दिए गए कोड सैंपल में, list_courses एमसीपी टूल को कॉल करने के लिए curl का इस्तेमाल करने का तरीका बताया गया है.

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"). इस अनुरोध में मौजूद तारीखों को इसी टाइमज़ोन के हिसाब से समझा जाता है. साथ ही, जवाब में मौजूद तारीखों को इसी टाइमज़ोन के हिसाब से फ़ॉर्मैट किया जाता है. यह टाइमज़ोन, Classroom में उपयोगकर्ता को दिखने वाले टाइमज़ोन से मैच करता है.

titleContains

string

ज़रूरी नहीं. केस-इनसेंसिटिव सबस्ट्रिंग के हिसाब से टाइटल को फ़िल्टर करें.

pageSize

integer

ज़रूरी नहीं. इससे पेज का साइज़ कंट्रोल किया जाता है. डिफ़ॉल्ट तौर पर, यह वैल्यू 10 होती है. हालांकि, इसे ज़्यादा से ज़्यादा 50 पर सेट किया जा सकता है.

pageToken

string

ज़रूरी नहीं. पेजिनेशन के लिए टोकन.

DateRange

JSON के काेड में दिखाना
{
  "startDate": string,
  "endDate": string
}
फ़ील्ड
startDate

string

रेंज शुरू होने की तारीख शामिल है (फ़ॉर्मैट: YYYY-MM-DD).

endDate

string

रेंज के खत्म होने की तारीख (फ़ॉर्मैट: YYYY-MM-DD).

राज्य

किसी कोर्स की स्थितियां.

Enums
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

कोर्स बनाने की तारीख (फ़ॉर्मैट: YYYY-MM-DD). अगर वीडियो बनाने की तारीख की जानकारी नहीं है, तो इसे खाली छोड़ दें.

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

सिर्फ़ आउटपुट के लिए. सीखने के लक्ष्य का आईडी. कोई स्टैंडर्ड अटैच करने के लिए, search_course_standards से id का इस्तेमाल करें, न कि standardCode का.

type

enum (Type)

सिर्फ़ आउटपुट के लिए. सीखने के लक्ष्य का टाइप.

standardCode

string

सिर्फ़ आउटपुट के लिए. स्टैंडर्ड कोड (उदाहरण के लिए, "NY-2.NBT.4"). यह जानकारी सिर्फ़ स्टैंडर्ड के लिए अपने-आप भर जाती है.

title

string

सिर्फ़ आउटपुट के लिए. मानकों के लिए स्टेटमेंट का ब्यौरा या कौशल के लिए ऐसा टाइटल जिसे कोई भी व्यक्ति आसानी से पढ़ सके.

documentTitle

string

सिर्फ़ आउटपुट के लिए. पाठ्यक्रम के दस्तावेज़ का नाम. यह जानकारी सिर्फ़ स्टैंडर्ड के लिए अपने-आप भर जाती है.

भूमिका

किसी कोर्स में उपयोगकर्ता की भूमिकाएं.

Enums
ROLE_UNSPECIFIED भूमिका तय नहीं की गई है.
TEACHER शिक्षक की भूमिका.
COTEACHER सह-शिक्षक की भूमिका.
STUDENT छात्र/छात्रा की भूमिका.
INVITED_OR_INACTIVE न्योता दिया गया है या भूमिका चालू नहीं है.

राज्य

किसी कोर्स की स्थितियां.

Enums
STATE_UNSPECIFIED स्थिति सेट नहीं की गई है.
ACTIVE ऐक्टिव स्टेट.
ARCHIVED संग्रहित की गई स्थिति.
PROVISIONED प्रोविज़न की गई स्थिति.

टाइप

सीखने के लक्ष्य का टाइप.

Enums
TYPE_UNSPECIFIED सीखने के लक्ष्य के टाइप की जानकारी नहीं है.
STANDARD यह प्रॉपर्टी, किसी पाठ्यक्रम के सीखने के स्टैंडर्ड के लिए इस्तेमाल की जाती है.
SKILL शिक्षा से जुड़े किसी कॉन्सेप्ट या क्षमता को दिखाने वाली स्किल. Classroom में सिर्फ़ शिक्षक ही स्किल जोड़ या हटा सकता है.

टूल एनोटेशन

टूल के एनोटेशन, एमसीपी क्लाइंट को भेजे जाते हैं. इससे उन्हें किसी टूल से जुड़े बुनियादी जोखिम के बारे में जानकारी मिलती है. ज़्यादातर क्लाइंट इन संकेतों को भरोसेमंद नहीं मानते. हालांकि, इनका इस्तेमाल यह तय करने के लिए किया जा सकता है कि उपयोगकर्ता को पुष्टि करने का अनुरोध कब भेजा जाए.

टाइटल स्ट्रिंग के साथ-साथ, बूलियन हिंट के बारे में यहां बताया गया है:

  • readOnlyHint: अगर इसकी वैल्यू true है, तो टूल अपने एनवायरमेंट में बदलाव नहीं करता. डिफ़ॉल्ट: false.
  • destructiveHint: अगर इसकी वैल्यू true है, तो टूल नुकसान पहुंचाने वाली कार्रवाइयां कर सकता है. अगर यह वैल्यू false पर सेट है, तो टूल सिर्फ़ जोड़ने वाली कार्रवाइयां कर सकता है. डिफ़ॉल्ट: true.
  • idempotentHint: अगर इसकी वैल्यू true है, तो टूल को एक ही आर्ग्युमेंट के साथ बार-बार कॉल करने पर, उसके एनवायरमेंट पर कोई और असर नहीं पड़ेगा. डिफ़ॉल्ट: false.
  • openWorldHint: सही होने पर, टूल बाहरी इकाइयों की 'विशाल दुनिया' के साथ इंटरैक्ट कर सकता है. अगर यह वैल्यू 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