Skip to main content
Glama

Get an Apple tutorial (DocC)

apple_tutorial_get
Read-onlyIdempotent

Retrieve a tutorial from the local index by ID, returning its chapter list and estimated completion time; ingest tutorials first to enable lookup.

Instructions

Return a tutorial from local index (ingest first) including chapter list and estimated time.

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": {
      "id": "<id>"
    },
    "name": "apple_tutorial_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
formatNoResponse formatmarkdown

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.2.3
    • removedInput schema / additionalProperties
      Removed value: -false
  2. First observedv0.2.1

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, closed-world and non-destructive, so the safety bar is largely met. The description adds two pieces of genuine behavior beyond that: the data comes from a local index requiring prior ingestion, and the response includes chapters and an estimated time. It omits failure behavior when the id is absent from the index.

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?

One front-loaded sentence with no filler; the prerequisite is parenthetically attached rather than buried. It could be tightened slightly, but every clause carries information.

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?

For a two-parameter read tool with full annotations and no output schema, the basics are covered, but the missing id semantics and the lack of any hint about retrieving ids first leave a real gap for an agent that must construct the call.

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 only 50%: the required "id" parameter has no schema description at all, and the description never explains what an id looks like or where it comes from (a search tool, a URL, a slug). The "format" enum is documented in the schema but never mentioned here, so the description does not compensate for the coverage gap.

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?

"Return a tutorial from local index" pairs a specific verb with a specific resource and adds what the payload contains (chapter list, estimated time). It is clearly not a search or list tool, though it never names the sibling get-tools (apple_doc_get, wwdc_get_session) it could be confused with.

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 "(ingest first)" gives a real prerequisite, which is useful context. But there is no statement of when to prefer this over apple_doc_get or the wwdc_get_* retrieval tools, and no guidance on what to do when the index lacks the tutorial.

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