Skip to main content
Glama
saigyujikingyo-png

UoE Companion

by saigyujikingyo-png
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

study_search

Read-onlyIdempotent

Search cached University of Edinburgh courses, resources, events, and assignments. Returns 20 compact results per page; use offset to continue. Not live search.

Instructions

Search cached courses/resources/events. Returns 20 compact rows by default; continue with next_offset. Use detail=full for full excerpts. Not live search.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
kindNo
limitNo
queryNo
detailNocompact
offsetNo
course_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed11 schema fields changedv0.5.0
    • removedInput schema / properties / course_id / anyOf
      Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
    • addedInput schema / properties / course_id / oneOf
      Added value: +[
+  {
+    "type": "string"
+  },
+  {
+    "type": "null"
+  }
+]
    • removedInput schema / properties / course_id / title
      Removed value: -"Course Id"
    • removedInput schema / properties / detail / title
      Removed value: -"Detail"
    • removedInput schema / properties / kind / anyOf
      Removed value: -[
-  {
-    "enum": [
-      "course",
-      "resource",
-      "assignment",
-      "event",
-      "announcement",
-      "service"
-    ],
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
    • addedInput schema / properties / kind / oneOf
      Added value: +[
+  {
+    "enum": [
+      "course",
+      "resource",
+      "assignment",
+      "event",
+      "announcement",
+      "service"
+    ],
+    "type": "string"
+  },
+  {
+    "type": "null"
+  }
+]
    • removedInput schema / properties / kind / title
      Removed value: -"Kind"
    • removedInput schema / properties / limit / title
      Removed value: -"Limit"
    • removedInput schema / properties / offset / title
      Removed value: -"Offset"
    • removedInput schema / properties / query / title
      Removed value: -"Query"
    • removedInput schema / title
      Removed value: -"study_searchArguments"
  2. First observedv0.4.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/local safety, so the bar is lower; the description adds genuinely useful behavior the annotations don't cover: default page size of 20 compact rows, offset-based continuation, and the compact-vs-full detail mode. It doesn't state rate limits or empty-result behavior, but it adds real value beyond structured fields.

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

Conciseness5/5

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

Four short sentences, each carrying distinct information (scope, default page, continuation, detail mode, live-vs-cached caveat), with the most decision-relevant constraint ('Not live search') positioned prominently. No filler.

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?

With no output schema, the description usefully characterizes the return shape (20 compact rows, next_offset for continuation, full excerpts via detail). It's nearly complete for a read-only search tool; only the filtering semantics of kind and course_id remain uncovered.

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 carries the burden. It explains limit (20 default), offset (next_offset continuation), and detail=full, but says nothing about kind's enum values or course_id filtering, and query is left entirely implicit. Partial compensation for six undocumented parameters.

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

Purpose5/5

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

States a specific verb (Search) and resource scope (cached courses/resources/events), and the phrase 'Not live search' explicitly separates it from live siblings like study_live_courses and study_live_resources. An agent can pick it out without opening any schema.

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 a clear when-not ('Not live search' → use live tools for fresh data) and routes pagination ('continue with next_offset') and the detail=full escalation. It stops short of naming the specific live alternative, so it's strong context rather than fully explicit routing.

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

Deploy Server

Other Tools