Skip to main content
Glama

line_search_guide

Search Norton Guide database entries for lines matching a query. Returns matching entries with line index and plain text content.

Instructions

Search all entries in a Norton Guide for lines matching a query string.

The search is performed on plain text (markup stripped) and returns all entries that contain at least one matching line.

Args: path: Absolute path to the .ng file. query: The text string to search for. case_sensitive: When True, the search is case-sensitive. Defaults to False.

Returns: A list of match dictionaries. Each dictionary contains:

- ``offset`` (int): Byte offset of the matching entry.
- ``type`` (str): ``"short"`` or ``"long"``.
- ``matching_lines`` (list[dict]): Each item has:

  - ``line_index`` (int): Zero-based line number within the entry.
  - ``text`` (str): Plain-text content of the matching line.

Raises: FileNotFoundError: If path does not point to an existing file.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
queryYes
case_sensitiveNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

With no annotations provided, the description carries the full burden. It discloses that the search is performed on plain text with markup stripped, returns all entries with matching lines, and raises FileNotFoundError for missing paths. It does not explicitly state that the tool is read-only, but that is implied. Additional behavioral details like potential performance impact or handling of large files are absent, but the core behavior is well-covered.

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?

The description is well-structured with Args, Returns, and Raises sections. It is front-loaded with the main purpose. While it is somewhat lengthy, each section adds value and there is no unnecessary repetition. Could be slightly more concise but overall effective.

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?

Given the presence of an output schema (though not detailed here), the description adequately covers the return format and error conditions. It explains all parameters and the behavior of the search. It does not guide the user on when to choose this tool over siblings, but that is a minor gap. For a tool with moderate complexity, the description is complete.

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

Parameters5/5

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

The input schema has 0% schema description coverage, so the description provides all parameter semantics. It clearly explains each parameter: 'path' as absolute path to .ng file, 'query' as text string to search for, and 'case_sensitive' with default False and boolean type. This adds significant meaning beyond the schema.

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 searches all entries in a Norton Guide for lines matching a query string. It specifies the verb 'search', the resource 'entries in a Norton Guide', and the scope 'all entries'. This distinguishes it from sibling tools like 'body_search_guide' (likely searches within bodies) and 'list_entries' (lists entries without search).

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 description explains what the tool does but does not explicitly state when to use it versus alternatives like 'body_search_guide' or 'read_entry'. The context from sibling tools implies different purposes, but no guidance is provided on when this search is preferred. The description lacks explicit when-not or alternative tool mentions.

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/davep/ngmcp'

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