Skip to main content
Glama

get_guide

Get detailed information about a running guide, including FAQs and related tools, by specifying the guide slug.

Instructions

Get detailed information about a specific running guide including FAQs and related tools

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesGuide slug, e.g. "first-marathon-training", "couch-to-5k-complete-guide"

Implementation Reference

  • The handler function for the 'get_guide' tool. It fetches guide data from the RunDida API using a slug parameter, then formats the response with title, description, URL, category, related tools, FAQs, and language links.
    // Tool: get_guide
    server.tool(
      'get_guide',
      'Get detailed information about a specific running guide including FAQs and related tools',
      { slug: z.string().describe('Guide slug, e.g. "first-marathon-training", "couch-to-5k-complete-guide"') },
      async ({ slug }) => {
        const data = await fetchJSON(`${BASE_URL}/api/guides/${slug}.json`);
        const g = data.guide;
        let text = `## ${g.title}\n\n${g.description}\n\nURL: ${g.url}\nCategory: ${g.category}\n`;
        if (g.relatedTools.length) text += `\nRelated tools: ${g.relatedTools.join(', ')}`;
        if (g.faqs && g.faqs.length) {
          text += '\n\n### FAQs\n';
          g.faqs.forEach(f => { text += `\n**Q: ${f.question}**\nA: ${f.answer}\n`; });
        }
        text += `\nAvailable in: EN (${g.links.page}), ZH (${g.links.pageZh}), JA (${g.links.pageJa})`;
        return { content: [{ type: 'text', text }] };
      }
    );
  • index.js:374-377 (registration)
    Registration of the 'get_guide' tool on the MCP server with its description and schema (slug parameter of type string).
    server.tool(
      'get_guide',
      'Get detailed information about a specific running guide including FAQs and related tools',
      { slug: z.string().describe('Guide slug, e.g. "first-marathon-training", "couch-to-5k-complete-guide"') },
  • Input schema for the 'get_guide' tool: a single 'slug' string parameter described as 'Guide slug, e.g. "first-marathon-training", "couch-to-5k-complete-guide"'.
    'Get detailed information about a specific running guide including FAQs and related tools',
    { slug: z.string().describe('Guide slug, e.g. "first-marathon-training", "couch-to-5k-complete-guide"') },
  • The fetchJSON helper function used by the handler to fetch guide data from the RunDida API with caching support.
    async function fetchJSON(url) {
      const cached = cache.get(url);
      if (cached && Date.now() - cached.ts < CACHE_TTL) return cached.data;
    
      const res = await fetch(url);
      if (!res.ok) throw new Error(`HTTP ${res.status}: ${url}`);
      const data = await res.json();
      cache.set(url, { data, ts: Date.now() });
      return data;
    }
Behavior3/5

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

No annotations provided, so description carries full burden. It mentions output includes FAQs and related tools, but lacks details about error handling or other behaviors.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Single sentence, no wasted words, conveys the main purpose efficiently.

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 lookup tool with one parameter and no output schema, the description is mostly complete. It explains what the tool returns. Minor omission: no mention of return format.

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% with example values. Description adds no extra meaning beyond what the schema provides for the slug parameter.

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?

The description clearly states the verb 'Get' and the resource 'detailed information about a specific running guide', and distinguishes itself from siblings like `list_guides` which lists guides without details.

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 implied but no explicit when-to-use or alternatives given. The description doesn't mention not to use it for browsing or for getting tool info.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/XWeaponX7/rundida-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server