schedule.json

{
  "name": "Schedule",
  "access": {
    "anon": "Can read public schedule information.",
    "user": "Can read public schedule information. Cannot modify schedule fact data.",
    "admin": "Can read public schedule information. Does not directly modify schedule facts through ordinary pages.",
    "agent": "Can read schedules for specific sections; current-user schedule aggregation is primarily exposed via MCP; public schedule retrieval is available through REST and MCP."
  },
  "rules": {
    "schedule-definition": "Schedule refers to a section's class times, locations, and week patterns.",
    "schedule-as-context": "The schedule within a section detail page is not treated as an isolated table but as an important entry point for understanding the section context.",
    "personal-calendar-integrates": "The personal calendar integrates subscribed section schedules, homework due dates, exam times, and personal todo due dates."
  },
  "capabilities": {
    "my-schedule": {
      "title": "My Schedule",
      "auth": "user",
      "links": {
        "models": ["Schedule"]
      },
      "web": {
        "pages": ["/?tab=calendar"]
      },
      "rest": "unavailable",
      "mcp": {
        "tools": [
          {
            "name": "list_my_schedules",
            "returns": "{ schedules: ScheduleEntry[] }",
            "notes": [
              "Returns schedules[]; each item contains date, weekday, startTime, endTime, section.course.namePrimary, section.code, room, teachers[], and scheduleGroup."
            ]
          }
        ]
      },
      "display": {
        "fields": [
          "7-day grid (Sun-Sat)",
          "Today highlight",
          "schedule.date",
          "schedule.startTime - endTime",
          "schedule.room.namePrimary",
          "section.course.namePrimary",
          "teacher names"
        ],
        "filters": ["Previous/next semester links"]
      }
    },
    "public-schedule-query": {
      "title": "Public Schedule Query",
      "auth": "anon",
      "links": {
        "models": ["Schedule"]
      },
      "web": "unavailable",
      "rest": {
        "routes": [
          {
            "path": "/api/schedules",
            "returns": "PaginatedResponse<ScheduleEntry>",
            "notes": [
              "Supports filtering by section, teacher, room, date range, and day of week.",
              "REST/MCP both accept exact JW/code-style filters for schedules so callers do not need to resolve internal numeric IDs first."
            ]
          }
        ]
      },
      "mcp": {
        "tools": [
          {
            "name": "query_schedules",
            "returns": "PaginatedResponse<ScheduleEntry>",
            "rest_equivalent": "GET /api/schedules"
          }
        ]
      },
      "display": {
        "filters": [
          "sectionId",
          "sectionJwId",
          "sectionCode",
          "teacherId",
          "teacherCode",
          "roomId",
          "roomJwId",
          "dateFrom/dateTo",
          "weekday"
        ]
      }
    },
    "section-schedule": {
      "title": "Section Schedule",
      "auth": "anon",
      "links": {
        "models": ["Schedule"]
      },
      "web": {
        "pages": ["/sections/[jwId]"]
      },
      "rest": {
        "routes": [
          {
            "path": "/api/sections/[jwId]/schedules",
            "returns": "ScheduleEntry[]",
            "notes": [
              "Returns a simplified variant of ScheduleEntry[] for the section."
            ]
          },
          {
            "path": "/api/sections/[jwId]/schedule-groups",
            "returns": "ScheduleGroupEntry[] (with schedules)",
            "notes": [
              "Returns schedule groups with schedules, not separate aggregated period summaries."
            ]
          }
        ]
      },
      "mcp": {
        "tools": [
          {
            "name": "list_schedules_by_section",
            "returns": "{ found: Boolean, section: Section?, schedules: ScheduleEntry[] }",
            "rest_equivalent": "GET /api/sections/[jwId]/schedules",
            "notes": [
              "Default/summary responses omit the repeated per-item section payload because the top-level section already scopes the list.",
              "Accepts optional dateFrom/dateTo to narrow results to a specific window (e.g. the current week); both accept flexible date strings."
            ]
          },
          {
            "name": "get_my_7days_timeline",
            "auth": "user",
            "returns": "{ range: { from: DateTime, to: DateTime }, total: Int, events: CalendarEvent[] }",
            "notes": [
              "Returns schedules as the schedule type within a unified event stream.",
              "Summary mode returns grouped counts/day slices plus a limited event sample instead of another full raw event dump.",
              "Accepts optional atTime to anchor the 7-day window to a specific moment instead of the server clock; useful for asking about a future week."
            ]
          }
        ]
      },
      "display": {
        "fields": [
          "schedule.date",
          "schedule.startTime - endTime",
          "schedule.room (with building/campus)",
          "schedule.weekday (0=Sunday)",
          "schedule.teachers[] names"
        ]
      }
    }
  }
}