Skip to main content
Glama

Read a product guide

knacco_get_product_guide
Read-only

Read an owned product’s instructions and latest published file list using a slug from knacco_list_library or knacco_search_library. Returns slug, title, subtitle, Markdown guide, files, productUrl and an assigned licenseKey when applicable. Each file includes assetId for knacco_get_download_link; this call does not download files. Courses are unavailable; software and plugins return requirements, compatibility and files. Requires content:read and product access; missing or unowned products return an error. Guide and license reads are logged.

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": {
      "slug": "<slug>"
    },
    "name": "knacco_get_product_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault
slugYesExact product slug returned by the library tools, such as kit-prompt-writing-system. Use the slug, not a URL or assetId.
localeNoLanguage for product text: en or he. Defaults to the connected account language; untranslated fields fall back to their original text.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, and the description adds substantive context beyond them: permission requirements, error conditions for missing or unowned products, the fact that guide and license reads are logged, and the licenseKey presence when applicable. It also clarifies that software/plugin products return requirements and compatibility rather than a course-style guide.

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?

Front-loaded with the action and resource, then progressively adds return fields, sibling routing, content-type caveats, and permissions. Dense but nearly every clause carries information; the return-field enumeration is the only part that could be tightened given it substitutes for a missing output schema.

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

Completeness5/5

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

No output schema exists, but the description compensates by enumerating the returned fields (slug, title, subtitle, Markdown guide, files, productUrl, licenseKey) and the assetId needed for the download tool. Combined with permission, error, and logging disclosure, nothing material is missing for a two-parameter read tool.

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 coverage is 100%, so both parameters are already documented, including the slug format constraint and the locale enum with its fallback behavior. The description reinforces slug provenance but adds nothing about the locale parameter, so the baseline 3 is appropriate.

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 and resource: 'Read an owned product's instructions and latest published file list', and names the exact source of the identifier (a slug from knacco_list_library or knacco_search_library). This clearly separates it from sibling list/search tools and from knacco_get_download_link, which the description explicitly says it does not replace.

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

Usage Guidelines5/5

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

Explicit about when to use it (with a slug obtained from the two library tools), when not to (courses are unavailable; it does not download files — assetId feeds knacco_get_download_link), and what different content types return. Prerequisites (content:read, product access) and failure behavior (error on missing/unowned products) are spelled out.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources