Skip to main content
Glama
ByteAsk

byteask-embedded-docs

Official
by ByteAsk

get_context

Retrieve the full verbatim section for a previous search hit, providing complete context from the documentation.

Instructions

Expand a previous search hit to its full verbatim section (markdown).

Args:
    result_id: The result_id from a search_docs hit.
    effort: Internal diagnostics tag; clients should leave this unset.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
result_idYes
effortNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior3/5

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

With no annotations provided, the description must fully disclose behavioral traits. It does mention that effort is an 'internal diagnostics tag' and should be left unset, adding useful context. However, it does not explicitly state that the operation is read-only or non-destructive, nor does it describe any side effects or prerequisites beyond the implied search hit. The word 'expand' suggests retrieval, but the description could be more explicit about safety and behavior.

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?

The description is concise and well-structured. It front-loads the primary action in the first sentence, then provides a clean argument list. Every sentence is informative, with no fluff or repetition.

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, focused tool, the description is quite complete. It explains the core function, the required parameter's origin, and the internal nature of the optional parameter. The output schema exists, so return-value details are not required. It could be slightly more complete by explicitly stating how this tool relates to request_document, but overall it covers the essential context.

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?

The schema has 0% description coverage, but the description compensates by explaining both parameters: result_id is sourced from a search_docs hit, and effort is an internal diagnostics tag that clients should not set. This adds meaningful semantic value beyond the raw schema, though it lacks examples or format details.

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 tool's function: 'Expand a previous search hit to its full verbatim section (markdown).' This uses a specific verb (expand) and resource (search hit), and distinguishes it from siblings like search_docs and request_document by focusing on retrieving the full context of a specific hit.

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

Usage Guidelines4/5

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

The description implies when to use it: after a search_docs hit, by referencing 'previous search hit' and 'result_id from a search_docs hit.' It provides clear context for the intended workflow but does not explicitly mention alternatives or when not to use it, so it stops short of full exclusion guidance.

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