Skip to main content
Glama

uplus_inspect_experiment

Extract an experiment's authoring brief: get handbook-provided sections separated from sections you must write, and optionally locate a downloadable report template.

Instructions

Read an experiment and return the authoring brief.

Opens the experiment detail page, reads 实验提交物 / 实验手册 / 实验附件, and (when find_template) searches all three sources for a downloadable report template — 实验附件 first, then downloadable files on the 实验手册 tab, then the course 资料 section (including its folders). The first source that yields a downloadable template file wins.

The result separates:

  • auto_sections — 目的 / 内容 / 步骤 / 要求 copied verbatim from the handbook; the server fills these and never rewrites them.

  • needed_sections — 实验实现 / 实验结果 / 实验总结 (plus any template section with no handbook text). Write these yourself from the requirements and attachments, then return {"sections": {"实验实现": "...", ...}} and call uplus_answer_experiment.

template_source reports which source the template came from (实验附件 / 实验手册 / 资料) or empty when no template was found. Nothing is filled, uploaded or submitted by this tool.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "course_id": "<course_id>",
      "exp_id": "<exp_id>",
      "stu_exp_id": "<stu_exp_id>"
    },
    "name": "uplus_inspect_experiment"
  }
}

Input Schema

NameRequiredDescriptionDefault
exp_idYes
course_idYes
stu_exp_idYes
find_templateNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.8.3

TDQS

A3.6/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the burden and does reasonably well: it declares "Nothing is filled, uploaded or submitted by this tool" (read-only) and discloses the template search order with first-match-wins and empty template_source on failure. It omits whether a login/session is required, what happens if the experiment page is inaccessible, and the cost of opening a page.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Purpose is front-loaded in the first sentence, followed by clearly scoped bullets for the two section categories. Length is justified by the amount of behavioural detail, though a few phrases (the enumerated Chinese section names, the repeated template-source list) could be tightened.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

No output schema exists, and the description compensates by describing the returned structure (auto_sections, needed_sections, template_source and their meanings) plus the follow-up contract. The main remaining hole is the semantics of the three required IDs and any prerequisite authentication.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

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 find_template thoroughly (search all three sources, priority order, default true), but the three required parameters course_id, exp_id and stu_exp_id are never defined, and the exp_id vs stu_exp_id distinction — the most confusing part of the schema — is left entirely unexplained.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Opens with a specific verb+resource ("Read an experiment and return the authoring brief") and then enumerates the outputs (auto_sections, needed_sections, template_source), so its purpose is unambiguous. It never contrasts itself with the closely named sibling uplus_read_experiment_detail, so an agent must infer the distinction from name alone.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives clear workflow context: fill needed_sections yourself, then call uplus_answer_experiment; and states that auto_sections must not be rewritten. find_template's default behaviour is described. It stops short of any explicit 'do not use this when...' or naming of the read/audit siblings, so exclusions are absent.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.