Skip to main content
Glama
Sign In
@octri/mcp

@octri/mcp

by OctriDev
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

get_guide

Read-onlyIdempotent

Retrieve a full tutorial or conceptual guide by slug so AI assistants can read complete documentation content instead of only search snippets.

Instructions

Get the full content of a written guide (tutorial / conceptual doc) by its slug

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": "get_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault
slugYesThe guide slug (from list_endpoints)
groupSlugNoThe guide's group (list_endpoints shows it). Optional: found from the site's navigation when omitted.
projectIdNoProject to read. Optional: defaults to the project this server was started with. Only pass it to target a different project.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.4.2
    • changedInput schema / properties / groupSlug / description
      Previous value: -"The guide's section slug, if it belongs to one"New value: +"The guide's group (list_endpoints shows it). Optional: found from the site's navigation when omitted."
    • changedInput schema / properties / projectId / description
      Previous value: -"Project to read. Optional — defaults to the project this server was started with. Only pass it to target a different project."New value: +"Project to read. Optional: defaults to the project this server was started with. Only pass it to target a different project."
  2. First observedv1.1.1

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint, and destructiveHint=false, so the safety profile is fully covered. The description adds only that the entire document is returned rather than an excerpt, with no mention of size, truncation, or response shape for potentially long guides.

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?

A single front-loaded sentence with no filler, and the parenthetical clarification is well placed. It is efficient but leaves obvious space unused for distinguishing siblings.

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?

For a simple one-required-parameter read with rich annotations and complete schema coverage, this is largely sufficient. The only shortfall is that agents get no hint about document size or output format for large guides.

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 100%, so slug, groupSlug, and projectId are already documented, including the fallback behavior for groupSlug and the project default. The description only echoes that retrieval is keyed by slug, adding nothing the schema does not already say.

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?

States a specific verb and resource ("Get the full content of a written guide") and disambiguates the resource with the parenthetical "tutorial / conceptual doc", which separates it from endpoint/SDK siblings. It does not explicitly contrast with search_docs, so retrieval-vs-search must be inferred.

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?

Usage is only implied: the schema's "from list_endpoints" hints at a discover-then-fetch flow, and the description's "full content" implies search_docs returns partial matches. There is no explicit statement of when to use this instead of search_docs or get_endpoint.

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