Skip to main content
Glama

note_up

Read-onlyIdempotent

Fetch citation-linked note-up data for Hong Kong criminal-law research; use it as a research aid, not as a citator.

Instructions

Return note-up data (research aid, not a citator).

allow_live follows HK_LAW_LOCAL_ONLY; the public default uses the cache only.

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": {
      "citation": "<citation>"
    },
    "name": "note_up"
  }
}

Input Schema

NameRequiredDescriptionDefault
forceNo
citationYes
allow_liveNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.3.0
    • addedInput schema / properties / allow_live
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "boolean"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Allow Live"
      +}
  2. First observedv0.2.0

TDQS

B3.4/5.0
Behavior4/5

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

Beyond the readOnly/idempotent annotations, the description discloses genuinely useful behavior: allow_live is gated by the HK_LAW_LOCAL_ONLY environment variable and the public default is cache-only, which tells the agent about network and freshness tradeoffs. It stops short of saying what the cache staleness or failure mode is when an item is uncached.

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?

Two short sentences, front-loaded with the purpose and the citator caveat. Nothing is padded, though the backtick/formatted environment-variable clause is slightly awkward inline.

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

Completeness3/5

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

With 0% schema coverage and no output schema, the description should do more: it omits the citation format, the meaning of force, and any hint of the shape of returned note-up data. It is adequate for a small read-only lookup but leaves real gaps.

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

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0%, so the description must carry all parameter meaning. It explains allow_live's environment gating well, but adds nothing about the required citation format or what force does — two of three parameters remain undocumented in either place.

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?

The description gives a specific verb and resource ("Return note-up data") and adds a meaningful domain qualifier — a research aid rather than a citator. It does not differentiate against siblings such as verify_citation or case_graph, which an agent might reasonably confuse with a citation tool, so it falls short of a 5.

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

Usage Guidelines3/5

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

The parenthetical "research aid, not a citator" implies a boundary, but it never names the alternative a user should reach for when citator-style verification is wanted. Usage is implied rather than stated, leaving the agent to infer when this is the right call.

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