Skip to main content
Glama

Get a guide's free overview and cited sources

get_guide_section
Read-only

Return the free overview excerpt for a flagship engineering guide plus the apex take-away link and cited source books (EP-204). Optionally supply a section name to get a specific section summary and its grounding citations.

Input Schema

NameRequiredDescriptionDefault
slugYesGuide slug: software-engineering, ai-engineering, or data-engineering.
sectionNoSection name substring, e.g. 'decoupling'. Returns the first matching section's summary and grounding citations.

Output Schema

NameRequiredDescriptionDefault
laneYes
titleYes
sectionYes
sourcesYes
overviewYes
guide_slugYes
api_versionYes
take_away_urlYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "api_version": {
      +      "type": "string"
      +    },
      +    "guide_slug": {
      +      "type": "string"
      +    },
      +    "lane": {
      +      "enum": [
      +        "ai",
      +        "data",
      +        "software"
      +      ],
      +      "type": "string"
      +    },
      +    "overview": {
      +      "type": "string"
      +    },
      +    "section": {
      +      "anyOf": [
      +        {
      +          "additionalProperties": false,
      +          "properties": {
      +            "grounded_in": {
      +              "items": {
      +                "additionalProperties": false,
      +                "properties": {
      +                  "library_id": {
      +                    "type": "string"
      +                  },
      +                  "note": {
      +                    "type": "string"
      +                  },
      +                  "title": {
      +                    "type": "string"
      +                  }
      +                },
      +                "required": [
      +                  "title"
      +                ],
      +                "type": "object"
      +              },
      +              "type": "array"
      +            },
      +            "name": {
      +              "type": "string"
      +            },
      +            "summary": {
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "name",
      +            "summary",
      +            "grounded_in"
      +          ],
      +          "type": "object"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "sources": {
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "library_id": {
      +            "type": "string"
      +          },
      +          "title": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "title"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "take_away_url": {
      +      "type": "string"
      +    },
      +    "title": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "api_version",
      +    "guide_slug",
      +    "title",
      +    "lane",
      +    "overview",
      +    "take_away_url",
      +    "sources",
      +    "section"
      +  ],
      +  "type": "object"
      +}
  2. Added

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so safety is covered. The description adds content context (free excerpt, apex take-away link, cited source books, grounding citations), but does not disclose anything about limits, auth, or freshness beyond what structured fields provide.

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 tight sentences with the primary return front-loaded and the optional behavior second. The '(EP-204)' reference is minor clutter but does not impede comprehension.

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 an output schema present, return values need no explanation, and annotations cover the safety profile; both parameters are fully documented. Complete for correct invocation, missing only cross-tool routing that would make it excellent.

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%, including the slug value list and the 'first matching section' substring behavior, so the schema does the heavy lifting. The description only restates the section semantics, adding no syntax or format detail beyond the schema.

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 ('Return') and resource ('free overview excerpt for a flagship engineering guide') plus the optional section-summary behavior. It is clearly distinguishable from get_concept/get_library_book by content type, though it does not name any sibling explicitly.

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 optional section parameter is framed with its effect ('to get a specific section summary and its grounding citations'), which is useful implied guidance. However, there is no statement of when to choose this tool over siblings such as get_concept, get_library_book, or search_library.

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