main

get_framework_docs

Retrieves authoritative documentation directly from the framework's official repository.

When to Use

Called during i18n_checklist Steps 1-13.

The checklist tool coordinates when you need framework documentation. Each step will tell you if you need to fetch docs and which sections to read.

If you're implementing i18n: Let the checklist guide you. Don't call this independently

Why This Matters

Your training data is a snapshot. Framework APIs evolve. The fetched documentation reflects the current state of the framework the user is actually running. Following official docs ensures you're working with the framework, not against it.

How to Use

Two-Phase Workflow:

Discovery - Call with action="index" to see available sections
Reading - Call with action="read" and section_id to get full content

Parameters:

framework: Use the exact value from get_project_context output
version: Use "latest" unless you need version-specific docs
action: "index" or "read"
section_id: Required for action="read", format "fileIndex:headingIndex" (from index)

Example Flow:

// See what's available
get_framework_docs(framework="nextjs-app-router", action="index")

// Read specific section
get_framework_docs(framework="nextjs-app-router", action="read", section_id="0:2")

What You Get

Index: Table of contents with section IDs
Read: Full section with explanations and code examples

Use these patterns directly in your implementation.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`action`	No		index
`context`	Yes	Explain why you are calling this tool and how it fits into the user's overall goal. This parameter is used for analytics and user intent tracking. YOU MUST provide 15-25 words (count carefully). NEVER use first person ('I', 'we', 'you') - maintain third-person perspective. NEVER include sensitive information such as credentials, passwords, or personal data. Example (20 words): "Searching across the organization's repositories to find all open issues related to performance complaints and latency issues for team prioritization."
`version`	No		latest
`framework`	Yes
`section_id`	No	Required if action='read'. Format: 'fileIndex:headingIndex'

TDQS

A4.5/5.0

Behavior4/5

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

With no annotations, the description carries full behavioral burden. It discloses the two-phase workflow (index then read), explains how actions behave, and mentions the return content ('Table of contents' vs. 'Full section'). It lacks error/edge-case detail but is notably more transparent than typical tools.

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?

Well-structured with clear headers and a code example, making a long description scannable. The 'Why This Matters' section is slightly motivational but adds context. Every section contributes to usability, though a bit verbose.

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 read-only docs tool with no output schema, the description explains workflow, parameters, and expected return values sufficiently. It ties into sibling tools (i18n_checklist, get_project_context) and provides an executable example. Missing edge-case behavior, but appropriate for the tool's simplicity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Description adds meaning beyond schema for action (via workflow), section_id (format and dependency on action), framework (exact value source), and version ('latest' default). It omits the context parameter, but the schema already covers that well. With only 40% schema coverage, description compensates substantially.

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?

Description opens with a specific verb+resource: 'Retrieves authoritative documentation directly from the framework's official repository.' It clearly distinguishes itself from sibling tools by focusing on framework docs (vs. i18n library docs) and is unambiguous about its scope.

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?

Explicitly states when to use ('Called during i18n_checklist Steps 1-13'), when not to use ('Don't call this independently'), and references the coordinating checklist tool. Also directs users to get_project_context for the exact framework value, providing an alternative context.

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

All main tools Inspect

Try in Browser

RayrunBuild, deploy, and operate MCP servers without becoming an infrastructure team.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A4.4/5.0

Disambiguation5/5

Each tool has a clearly distinct purpose: i18n_checklist orchestrates the workflow, get_project_context detects project setup, get_framework_docs fetches framework docs, and get_i18n_library_docs fetches library docs. Even though the two doc tools share a similar interface, their targets are explicitly different (framework vs library), and the checklist directs which to use when.

Naming Consistency4/5

Three tools follow the get_<object>_docs/context pattern, and i18n_checklist is a noun-style name. All are lowercase snake_case and descriptive, so the minor deviation from a strict verb_noun pattern is not confusing. The i18n_ prefix on the checklist also ties it to the server's domain.

Tool Count5/5

Four tools is well-scoped for a focused i18n implementation workflow. The checklist is the central orchestrator, with three supporting tools that each serve a necessary sub-task (context detection, framework docs, library docs). No tool feels redundant or missing.

Completeness5/5

The tool surface fully covers the i18n implementation lifecycle: i18n_checklist provides the step-by-step process, get_project_context gathers the required initial context, and the two doc tools supply current reference material. The checklist's evidence submission and build validation handle verification, so there are no obvious gaps or dead ends.

Resources

Need Help?