smu-elearn
[!IMPORTANT] 本项目不试图绕过或破坏 D2L 或 SMU 施加的认证和访问限制,而是选择在通过 Chrome 完成正规认证后直接使用 D2L API。本项目与 SMU 或 D2L 没有任何关联。如有任何问题,请直接联系我或创建一个 issue。
SMU eLearn MCP
一个面向 SMU 的 D2L Brightspace 部署的本地、只读 Model Context Protocol 服务器。它提供课程、置顶课程、每周模块、课程文档、最近的上传/更改、内容搜索、元数据和文件下载等功能。
这是一个本地、单用户的 stdio 服务。它不打算作为网络服务器对外暴露,也不打算在用户之间共享。
使用此 MCP 的最佳方式是通过 Codex 或 Claude,我已在 plugin-package/ 文件夹下将其打包为可安装的插件。
功能
MCP 工具 | 用途 |
| 打开 Chrome 进行 SMU SSO/MFA 认证,等待一分钟,自动验证并保存会话。 |
| 验证本地保存的浏览器会话能否访问 eLearn API。 |
| 列出/搜索可访问的课程,包含 ID、代码、日期、角色和置顶状态。 |
| 返回存在权威 D2L |
| 发现嵌套的 |
| 获取一个课程、一个教学周/模块的全部文档。 |
| 获取置顶/全部/选定课程中在某个日历周内上传或修改的文档。 |
| 递归列出单个课程中的全部文档。 |
| 跨课程搜索文档标题和模块路径。 |
| 获取某个 D2L 内容主题(topic)的元数据。 |
| 将主题文件下载到本地,且不覆盖已存在的文件。 |
该实现使用 D2L 官方文档记载的只读 API 路由。它不会抓取可见的主页,也不会修改课程、置顶状态、提交、成绩、消息或内容。
Related MCP server: mun-d2l-mcp
环境要求
Node.js 22 或更高版本
Google Chrome
一个有权访问 eLearn 的 SMU 账户
安装与认证
cd elearn-mcp
npm ci
npm run authnpm run auth 会打开一个专用的 Chrome 配置文件。完成常规的 SMU Microsoft 登录和 MFA 流程。一分钟后,该命令会自动检查 eLearn API;如果登录仍未完成,它会每 15 秒检查一次,最长持续五分钟。成功后,它会保存 Playwright 浏览器会话状态,将状态文件的权限限制为仅所有者可读写(0600),并关闭 Chrome。整个过程无需任何终端输入。
配置文件默认位于 ~/.elearn-mcp/browser-profile,保存的状态默认位于 ~/.elearn-mcp/storage-state.json。状态中包含会话 Cookie,并可能包含按来源(origin)划分的 Web 存储,因此请将这两个位置都视为机密:不要提交、同步或共享它们。MCP 绝不会要求或存储你的密码或 MFA 响应。
验证类型安全、单元测试和干净的生产构建:
npm run check完成认证后,运行完整的 MCP 实测:
npm run test:full完整运行会执行类型检查和单元测试,构建生产服务器,通过 MCP stdio 进行连接,针对 eLearn 真实数据验证全部 11 个工具,将一个真实文件下载到由操作系统提供的隔离临时目录中,验证该文件,并在 finally 清理中删除该临时目录。它绝不会在 eLearn 中提交或更改任何数据。
MCP 客户端配置
请先构建项目,然后配置你的 MCP 客户端,使其启动编译后的 stdio 服务器:
{
"mcpServers": {
"smu-elearn": {
"command": "node",
"args": [
"/absolute/path/to/elearn-mcp/dist/src/server.js"
],
"env": {
"ELEARN_BASE_URL": "https://elearn.smu.edu.sg",
"ELEARN_LP_VERSION": "1.49",
"ELEARN_LE_VERSION": "1.49",
"ELEARN_COURSE_ORG_UNIT_TYPE_ID": "3"
}
}
}
}这个 JSON 的确切位置取决于所用的 MCP 客户端。更改配置后,请重启客户端。
生产运行
服务器基于锁定依赖集构建。在验证过程中,测试会经过类型检查并被执行,但它们被排除在 dist/ 和可分发包之外。
如需一个最小的本地运行环境:
npm ci
npm run check
npm prune --omit=dev
npm start精简开发依赖后,请在重新构建或运行单元测试之前再次运行 npm ci。项目附带的 GitHub Actions 工作流会在 Node.js 22 上执行相同的锁定安装与验证。需要认证的实测被排除在 CI 之外,因为它需要交互式的 SMU 账户和 MFA。
构建 Codex 和 Claude 插件
src/ 下的 TypeScript 文件是 MCP 实现的唯一事实来源。Codex 和 Claude Code 使用各自的插件清单和 MCP 启动元数据,而两者接收的是相同的生成运行时:
plugin-package/
├── codex/smu-elearn/
│ ├── .codex-plugin/plugin.json
│ ├── .mcp.json
│ └── mcp/
└── claude/smu-elearn/
├── .claude-plugin/plugin.json
├── .mcp.json
└── mcp/使用以下命令构建两个全新的、自包含的插件包:
npm run build:pluginsnpm run build:plugin 仍然是同一命令的别名。该构建会编译一次 src/,从根 lockfile 推导出精确的生产依赖版本,在隔离的暂存目录中安装一次生产依赖,并且只有在完整的暂存副本通过验证之后,才会替换各个 mcp/ 目录。请勿手动编辑任一生成的运行时。
对于 Claude Code 开发,可以直接验证并加载该插件包:
claude plugin validate ./plugin-package/claude/smu-elearn --strict
claude --plugin-dir ./plugin-package/claude/smu-elearn在 Claude Code 中,运行 /mcp 以检查自带的服务器。如需持久化的本地安装,请先构建插件包,然后添加此仓库的 marketplace:
claude plugin marketplace add /absolute/path/to/elearn-mcp
claude plugin install smu-elearn@smu-local --scope usermarketplace 目录清单存储在 .claude-plugin/marketplace.json。Claude 会将完整插件包复制到其插件缓存中,因此生成的 mcp/ 运行时必须在安装之前存在。开发时请使用 --plugin-dir 绕过缓存并就地加载插件包。
配置
环境变量 | 默认值 | 含义 |
|
| eLearn 源站(origin)。 |
|
| D2L Learning Platform API 契约。 |
|
| D2L Learning Environment API 契约。 |
|
| D2L Course Offering 组织单元(org-unit)类型。 |
|
| 专用的 Chrome 认证配置文件。 |
|
| MCP 使用的、仅所有者可读写的 Playwright 会话状态。 |
|
| 首次自动登录检查之前的等待时间。 |
|
| SSO/MFA 尚未完成时的重试间隔。 |
|
| 交互式认证的最大时长。 |
|
| 下载文件的默认输出目录。 |
|
| 在无可见窗口的情况下运行已认证的 Chrome 上下文。 |
“周”的解读方式
elearn_get_week_documents将week解释为课程的教学内容模块,例如 Week 3。它会递归包含嵌套子模块中的文件。elearn_get_recent_documents将一周解释为日历日期范围,并按主题的 D2LLastModifiedDate进行过滤。如果省略since和until,则使用当前本地时间的周一至周日。
这种区别是有意为之:存放在“Week 3”中的文件可能是在另一个日历周上传的。
认证生命周期
elearn_authenticate MCP 工具和 npm run auth 命令会启动专用 Chrome 配置文件,用于由用户控制的 SSO 和 MFA。它们会在第一次自动检查前等待一分钟,如有需要会短暂轮询,验证 D2L API,并写入权限为 0600 的 Playwright 存储状态文件。服务器会使用该状态启动一个独立的无头(headless)Chrome 上下文,并通过它发送同源(same-origin)API 请求。这样既保留了 SMU 和 Microsoft 对交互式认证的控制,又允许 MCP 进程重启。当机构会话过期时,请调用 elearn_authenticate 或重新运行 npm run auth。
有关本地部署边界、凭据处理指南和发布检查,请参阅 SECURITY.md。
Available Tools
11 toolselearn_authenticateAuthenticate with SMU eLearnB
Open the dedicated Chrome profile for SMU SSO/MFA, wait one minute by default, automatically verify the login, save owner-only session state, and close Chrome.
| Name | Required | Description | Default |
|---|---|---|---|
| timeoutSeconds | No | ||
| initialWaitSeconds | No | ||
| pollIntervalSeconds | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full transparency burden. It discloses the sequence (open, wait, verify, save, close) and mentions 'owner-only session state,' which hints at file writes. However, it omits critical behavioral details: it does not state that interactive MFA may be required, that Chrome will close disrupting other tabs, or any failure/timeout behavior. This is a moderate gap.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence that front-loads the purpose and outlines the entire workflow with zero wasted words. It is concise, readable, and efficiently conveys the tool's core function.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's moderate complexity (3 parameters, no output schema, no annotations), the description is incomplete. It does not explain parameter usage, nor does it specify the return value or success/failure indicator, and it lacks explicit mention of user interaction needs (MFA). An agent would struggle to invoke it correctly without additional documentation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 0%, so the description must compensate. It only indirectly references 'wait one minute by default' (matching initialWaitSeconds default), but never names or explains timeoutSeconds or pollIntervalSeconds. The agent cannot infer parameter meaning from the description, which is a clear deficiency.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Authenticate'), a clear resource ('SMU eLearn'), and describes the full process (open Chrome profile, wait, verify, save state, close). It is immediately distinct from all sibling tools, which focus on documents/courses, not authentication.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives like elearn_auth_status, nor does it state preconditions (e.g., must be logged out, or must run before other tools). It implies usage only through its purpose, leaving the agent to infer when authentication is needed.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
elearn_auth_statusCheck eLearn authenticationA
Check whether the dedicated Chrome profile is currently authenticated with SMU eLearn.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the burden of behavioral disclosure. It states the tool checks authentication, which implies read-only behavior, but does not explicitly mention non-mutating characteristics or the return format. Given the simplicity of the tool, this is adequate but could be more explicit.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, clean sentence that directly states the tool's purpose without any fluff or redundancy. It is front-loaded and efficient, earning a top score.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with no parameters and a simple status-check function, the description is largely complete. However, it does not mention the return value or output format, which could be useful for an agent. Since there is no output schema, a brief note on what is returned (e.g., boolean) would improve completeness, but it is not critical.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has zero parameters and an empty schema (100% coverage). According to the calibration rule, a baseline of 4 applies for zero-parameter tools, and since there are no parameters to document, the description adds no additional semantic burden.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Check') and resource ('whether the dedicated Chrome profile is currently authenticated with SMU eLearn'), which clearly identifies the tool's function. It is distinct from sibling tools like elearn_authenticate, which performs authentication rather than checking it.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description clearly implies a status-check use case without explicit exclusions or alternatives. It does not name sibling tools or provide 'when not to use' guidance, but the purpose is unambiguous enough that an agent would know to call this before deciding whether further actions are needed.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
elearn_download_documentDownload an eLearn documentB
Download a file topic to the configured local download directory. Existing files are never overwritten; a numeric suffix is added.
| Name | Required | Description | Default |
|---|---|---|---|
| topicId | Yes | ||
| courseId | Yes | ||
| filename | No | ||
| destinationDir | No | Optional absolute destination directory. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description discloses a key behavioral trait: existing files are never overwritten and a numeric suffix is added. This is useful and not covered by annotations (none provided). It also implies the destination is configurable. However, it does not mention error handling, return values, or the exact file naming scheme, but the disclosed behavior is a significant safety-relevant detail.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two concise sentences with zero redundancy. The key action and the critical overwrite behavior are front-loaded, and every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given there is no output schema and no annotations, the description should cover what the tool returns, error conditions, and how IDs are obtained. It only states the action. It lacks crucial information for an agent to confirm success or handle failures, and does not mention whether the download is synchronous or asynchronous.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is only 25% (only destinationDir has a description). The description does not explain the parameters courseId, topicId, or filename, nor how they relate to the download. It mentions 'configured local download directory' but doesn't clarify that destinationDir is an optional override. The description fails to compensate for the low schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('download') and resource ('file topic') and indicates the destination (local download directory). It is clear and distinct from the sibling get/search tools, though it does not explicitly name alternatives. The main gap is that it doesn't mention what a 'topic' is or how to obtain the IDs, but the core purpose is unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives no guidance on when to use this tool versus alternatives, nor does it mention prerequisites like authentication (sibling authentications exist) or when not to use it. It is implied that you need courseId and topicId from other tools, but not stated. No exclusions or routing to siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
elearn_get_course_documentsGet all documents for a courseC
Return all accessible file topics in a course, recursively, with module paths and availability/modified dates.
| Name | Required | Description | Default |
|---|---|---|---|
| courseId | Yes | ||
| includeLinks | No | ||
| includeHidden | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of disclosing behavior. It states the tool returns 'all accessible file topics' recursively, implying permission-based filtering, and mentions the returned metadata (module paths, dates). However, it does not disclose authentication requirements, confirm read-only nature, or address potential error conditions. The term 'accessible' hints at filtering but lacks explicit detail on hidden or link handling, leaving partial transparency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, concise sentence of approximately 20 words. It front-loads the action and key return contents, avoiding unnecessary detail. While it omits parameter explanations, that is a completeness issue, not a conciseness one. The structure is clean and scannable, earning a high score for efficiency.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool has three parameters, no output schema, no annotations, and zero schema coverage. The description states the primary function but fails to explain the optional flags (includeLinks, includeHidden), any pagination or sorting defaults, or selection criteria relative to sibling tools. It is not sufficiently complete for an agent to invoke correctly without additional schema inspection.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, and the description does not explain any of the three parameters (courseId, includeLinks, includeHidden). It omits how these parameters affect output or defaults. The description entirely misses parameter semantics, forcing the agent to rely solely on parameter names, which is inadequate for optional flags like includeLinks and includeHidden.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool returns all accessible file topics in a course, recursively, with module paths and availability/modified dates. It uses a specific verb ('Return') and a specific resource ('file topics in a course'), making the purpose evident. However, it does not explicitly differentiate from sibling tools like elearn_get_week_documents or elearn_search_content, leaving the distinction implicit.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus its siblings. It does not mention alternatives, prerequisites, or scenarios where this tool is preferred over elearn_get_week_documents or elearn_search_content. The agent must infer usage context from the name and description alone, which is insufficient.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
elearn_get_document_metadataGet eLearn document metadataC
Get the D2L content-topic metadata for one course document.
| Name | Required | Description | Default |
|---|---|---|---|
| topicId | Yes | ||
| courseId | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure, yet it says only 'Get,' which implies a read operation without confirming it. It discloses nothing about authentication requirements (notably relevant given elearn_authenticate and elearn_auth_status siblings), the structure or extent of the returned metadata, failure behavior, or rate limits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single clean, front-loaded sentence with no wasted words, which is structurally sound. However, it leans toward under-specification rather than deliberate conciseness, delivering little information beyond what the name and title already convey.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
While the tool is simple (two scalar params), the 0% parameter coverage, absent output schema, and missing annotations mean the description must carry more weight. It omits parameter semantics, auth requirements, and return-value expectations, leaving an agent without enough information to call it correctly and interpret the result.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate, but it mentions no parameters at all. It does not clarify the semantic difference or hierarchy between courseId and topicId, or how they identify the target document. The description adds zero value for parameter understanding.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Get') and a specific resource ('D2L content-topic metadata for one course document'). The 'metadata' qualifier and 'one... document' scope clearly separate it from elearn_download_document (which fetches content) and elearn_search_content. It is fairly clear, though it does not explicitly distinguish itself from elearn_get_course_documents, which might also return metadata for documents.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is given on when to use this tool versus its siblings. It does not state when to prefer this over elearn_get_course_documents, elearn_get_week_documents, or elearn_search_content, nor any exclusions or prerequisites such as prior authentication. Usage context is only weakly implied by the phrase 'one course document.'
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
elearn_get_recent_documentsGet documents uploaded or modified during a calendar weekB
Search file topics by D2L LastModifiedDate across pinned courses (default), all active courses, or explicit course IDs. Defaults to the current Monday-through-Sunday week in local time.
| Name | Required | Description | Default |
|---|---|---|---|
| scope | No | pinned | |
| since | No | Inclusive ISO-8601 start time. | |
| until | No | Inclusive ISO-8601 end time. | |
| courseIds | No | Explicit course IDs override scope. | |
| maxCourses | No | ||
| includeLinks | No | ||
| includeHidden | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It discloses the default time window (Monday through Sunday in local time) and the default scope ordering (pinned, all, explicit IDs), which is useful. However, it omits many behavioral aspects like pagination, result format, handling of hidden/removed items, or authentication requirements. The description provides some transparency but leaves significant gaps.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences, tightly packed with essential information. The main purpose is up front, followed by the default time window. There is no filler or redundant wording, making it efficient for agent consumption.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given 7 parameters, no output schema, and no annotations, the description is too sparse. It does not explain return values, limits (maxCourses), behavior of includeLinks/includeHidden, or how results are ordered/sorted. An agent would need to guess many call details. The description does not sufficiently prepare an agent to use the tool correctly without additional exploration.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 43%, so the description must compensate for undocumented parameters. It adds context for 'scope' (pinned/all/explicit course IDs) and clarifies that courseIds override scope. However, it doesn't explain maxCourses, includeLinks, or includeHidden, whose schemas lack descriptions. The description adds moderate value but doesn't fully cover the parameter semantics gap.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool searches file topics by D2L LastModifiedDate, with specific scope options (pinned, all active, explicit course IDs). It distinguishes itself from course-specific tools by mentioning multiple course scopes, but doesn't explicitly contrast with sibling tools like elearn_get_week_documents. The verb 'Search' and resource 'file topics' make the purpose specific.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No explicit guidance on when to use this tool versus alternatives. It mentions the default behavior (pinned courses, current week) but doesn't state when to choose this over elearn_get_week_documents or elearn_get_course_documents. Agents must infer usage from the scope options without clear decision criteria.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
elearn_get_week_documentsGet documents for a course weekA
Return every accessible file topic recursively contained in matching Week modules for one course. Week can be a number (for example 3) or title fragment.
| Name | Required | Description | Default |
|---|---|---|---|
| week | Yes | A week number or module-title fragment, such as 3 or 'Week 3'. | |
| courseId | Yes | The numeric course ID. | |
| includeLinks | No | Also include link topics, not only files. | |
| includeHidden | No | Include hidden topics if the API exposes them. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must disclose behavior. It mentions 'recursively' and 'accessible', which gives some behavioral context, but it does not cover pagination, error handling, or implications of includeLinks/includeHidden beyond the schema. It's clearly read-only but that's implicit.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence that front-loads the core purpose, followed by a brief clarification of the week parameter. There is no fluff or redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With 4 parameters, no output schema, and no annotations, the description is thin. It doesn't clarify what 'accessible' means, whether results are paginated, or how this tool differs from elearn_get_course_documents. It would benefit from a note about when to prefer this over siblings and what the response structure looks like.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description adds minor context by explaining the week parameter can be a number or title fragment, which the schema already states. It does not add depth to courseId, includeLinks, or includeHidden beyond the schema descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Return'), the resource ('every accessible file topic'), scope ('for one course'), and specificity ('matching Week modules', 'recursively'). It distinguishes itself from siblings like elearn_get_course_documents or elearn_get_recent_documents by focusing on week-based retrieval.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies the use case (retrieve documents for a specific week) but does not explicitly state when to use this tool versus alternatives like elearn_get_course_documents or elearn_search_content. No exclusions or routing hints are provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
elearn_list_coursesList eLearn coursesC
List accessible SMU eLearn courses. Results include stable course IDs, course codes, term dates, access state, and pin state.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| search | No | Optional case-insensitive course name or code search. | |
| activeOnly | No | Only include active and accessible courses. | |
| pinnedOnly | No | Only include courses with a PinDate. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must disclose behavioral traits. It mentions the output fields but does not state whether authentication is required, whether it is read-only, or any rate limits or pagination behavior. The word 'List' implies a read operation, but this is implicit rather than explicit.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences with no filler. It front-loads the core action and then adds useful output details. Every word earns its place, making it efficient and well-structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the absence of an output schema and annotations, the description is too sparse. It does not mention authentication prerequisites (a sibling 'elearn_authenticate' exists), pagination behavior, or how the 'limit' parameter affects results. The listed output fields provide some context but not enough for an agent to fully understand the tool's expected usage.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema covers 75% of parameters with descriptions (search, activeOnly, pinnedOnly), but the description adds no parameter-specific guidance. The 'limit' parameter lacks a schema description and is not mentioned in the description either, leaving a gap. The mention of 'pin state' in the output hints at the pinnedOnly filter but does not explain how to use it.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('List') and resource ('accessible SMU eLearn courses'), and enumerates the output fields (course IDs, codes, term dates, access state, pin state). This is clear and specific, but it does not explicitly differentiate from the sibling tool 'elearn_list_pinned_courses', though the name and filters imply a more general listing.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives like 'elearn_list_pinned_courses' or when to prefer one filter over another. It simply states what it does without any context on selection criteria or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
elearn_list_course_weeksList weekly modules in a courseB
Find nested course-content modules named Week/Wk/W followed by a number and report their IDs, paths, dates, and document counts.
| Name | Required | Description | Default |
|---|---|---|---|
| courseId | Yes | The numeric course organization-unit ID from elearn_list_courses. | |
| includeLinks | No | ||
| includeHidden | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden for behavioral disclosure. It mentions what information is reported but does not explain any side effects (e.g., read-only vs. mutation), authentication requirements, how the includeLinks and includeHidden parameters alter behavior, or potential error conditions. The description adds some context about the naming pattern but leaves significant behavioral aspects undisclosed.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence that is direct and free of unnecessary words. It front-loads the core behavior ('Find nested course-content modules...') and then lists the reported attributes. There is no redundancy, and every phrase contributes to understanding the tool's purpose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool has three parameters (two undocumented), no output schema, and no annotations, the description should provide more context about how parameters affect results and what the return structure looks like. It only vaguely states that IDs, paths, dates, and document counts are reported, but doesn't specify the format, pagination, or how includeLinks/includeHidden change the output. The description is too sparse for an agent to fully anticipate the tool's behavior.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is only 33%, with only courseId having a descriptive text. The other two parameters, includeLinks and includeHidden, have no schema descriptions. The tool description does not compensate for this: it doesn't explain what these flags do, whether they affect filtering or output, or how they interact. For an agent to correctly set these parameters, additional meaning is needed but absent.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's function: it finds nested course-content modules named with Week/Wk/W followed by a number and reports specific fields (IDs, paths, dates, document counts). This is a specific verb-resource pair that differentiates it from sibling tools like elearn_get_week_documents, which likely retrieves documents for a given week. The naming pattern and reported fields make the purpose unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage by describing what it does (finding weeks), but it does not explicitly mention when to use this tool versus alternatives, nor does it state any exclusions or prerequisites. There is no guidance on when not to use it or when a different tool might be more appropriate, so it falls short of the 'explicit when/when-not' standard.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
elearn_list_pinned_coursesList pinned eLearn coursesC
List courses pinned by the current user, ordered by pin date and course name.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| search | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions ordering but does not state whether the operation is read-only, requires authentication, handles pagination, or what error behaviors might occur. The description stays at the surface level and does not go beyond what the name implies.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence that directly conveys the purpose without fluff. It is appropriately concise and well-structured for a simple list operation.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with two parameters and no annotations, the description is incomplete. It fails to explain the 'limit' and 'search' parameters, does not mention authentication requirements, and provides no information about the response format or potential errors. Even for a simple listing tool, these gaps could lead to incorrect invocation (e.g., passing an overly large search string or misinterpreting the ordering).
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema has no descriptions (0% coverage) and the description does not mention the parameters 'limit' or 'search' at all. An agent must rely solely on parameter names, which are somewhat self-explanatory but not fully defined. The description adds no value in explaining semantics, constraints, or how these parameters affect results.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('List'), the resource ('courses pinned by the current user'), and adds ordering criteria ('by pin date and course name'). It distinguishes itself from sibling tools like elearn_list_courses by specifying 'pinned by the current user'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is given on when to use this tool versus alternatives such as elearn_list_courses or elearn_search_content. The description implies it is for pinned courses only, but does not explicitly exclude other scenarios or mention any prerequisites like authentication. Contextual signals like sibling tool names could help, but the description itself offers no routing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
elearn_search_contentSearch eLearn course contentB
Search document titles and module paths across pinned courses, all active courses, or explicit course IDs.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| query | Yes | ||
| scope | No | pinned | |
| courseIds | No | ||
| maxCourses | No | ||
| includeLinks | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full responsibility for behavioral disclosure. It only explains what is searched (titles and module paths) but does not mention authentication requirements, result ordering, fuzzy vs. exact matching, or any side effects. For a search tool, this is a minimal disclosure that leaves significant behavioral unknowns.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single, front-loaded sentence that efficiently conveys the core function and scope options. No wasted words, and the most important information (what is searched) appears first.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given 6 parameters, no output schema, and no annotations, the description is far from complete. It does not explain parameter defaults, result format, or prerequisites like authentication. An agent would need to consult external documentation or make assumptions to use this tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate. It explains the 'scope' and 'courseIds' concepts (pinned, all, explicit course IDs) and hints at query semantics (titles, module paths), but completely ignores 'limit', 'maxCourses', and 'includeLinks'. For a tool with 6 parameters, this is insufficient semantic guidance.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states a specific verb 'Search' and resource 'document titles and module paths', and explicitly mentions the three scope options (pinned, all, explicit course IDs). This distinguishes it from sibling tools that retrieve documents by week or course, and leaves no ambiguity about its function.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for searching across courses, but does not explicitly state when to use this tool versus alternatives like elearn_get_week_documents or elearn_get_course_documents. It lacks direct guidance on exclusions or preferred scenarios, leaving the agent to infer context from the tool's purpose.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
11 tool updates
v0.1.0- First observed
elearn_auth_status - First observed
elearn_authenticate - First observed
elearn_download_document - First observed
elearn_get_course_documents - First observed
elearn_get_document_metadata - First observed
elearn_get_recent_documents - First observed
elearn_get_week_documents - First observed
elearn_list_course_weeks - First observed
elearn_list_courses - First observed
elearn_list_pinned_courses - First observed
elearn_search_content
TDQS
Scored across 11 tools
Each tool targets a distinct combination of resource and action: document retrieval by week, recency, course, search, metadata, download, plus authentication and listing. The slight overlap between get_week_documents and get_course_documents is clarified by their scope descriptions, making misselection unlikely.
All tools share the 'elearn_' prefix and follow a consistent verb_noun pattern (get_, list_, search_, download_, authenticate, auth_status). The only minor deviation is 'auth_status' being a noun phrase rather than verb+noun, but it remains clear and predictable within the set.
With 11 tools, the server is well-scoped for a course document retrieval and authentication workflow. Each tool serves a clear purpose without bloat, staying within the ideal 3-15 range for maintainability and agent usability.
The tool surface covers the full lifecycle of document access: authentication, listing courses and weeks, retrieving documents by multiple criteria, searching, obtaining metadata, and downloading. No obvious gaps exist for the stated domain of accessing eLearn course files.
Maintenance
Related MCP Connectors
Search, read and cite documents. Add, replace and delete files with write access. OAuth required.
PLATO (Pusan National University LMS) MCP server via Moodle Web Service API + ubboard scraping
Multi-engine scholarly research server for search, traversal, full text, and reading lists.
Read and search folders on your own computer with explicit consent. Files are never uploaded.
Related MCP Servers
- AlicenseBqualityDmaintenanceEnables browsing and collecting course materials from Brightspace through Chrome DevTools Protocol, allowing snapshotting, downloading media, and automating page navigation.22MIT
- AlicenseNot gradedqualityBmaintenanceProvides local, read-only access to Memorial University's Brightspace D2L courses, enabling students to view content, grades, assignments, quizzes, announcements, and deadlines through natural language.Apache 2.0
- AlicenseBqualityCmaintenanceEnables natural-language, read-only access to a user's own learning-management account for courses, assignments and deadlines, lecture attendance, notices, grades, and syllabus evidence, including reading page/slide/cell locations inside PDF, Office, HWP/HWPX, HTML, and ZIP attachments. Runs locally over stdio or remotely over OAuth-protected Streamable HTTP for desktop and mobile clients, and can compare changes against a locally encrypted baseline.19MIT
- AlicenseAqualityBmaintenanceEnables users to log into their university Moodle in a dedicated Chrome profile, choose courses from their real module list, and incrementally download lecture files to local versioned folders while preserving older versions of updated materials. Also exposes tools to check login and connection status, discover courses, list resources, and inspect per-item sync results.84MIT