Skip to main content
Glama

docgraph_search

Destructive

Full-text search across indexed documents. Returns matching documents and headings with snippets. Filter by governance, research, audience, or entity.

Instructions

Full-text search across all indexed Markdown documents. Returns matching documents and headings with snippets. For topic-level context, prefer docgraph_context which combines search with structure. Use governance and research filters to constrain retrieval without adding separate tools. Result paths carry a '#heading:line' suffix and (in workspace mode) a '[project/]' prefix — strip these to the bare file path before passing a path to docgraph_node / docgraph_graph / docgraph_context (a heading result also prints its bare 'parent document:' path for this).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
allowed_audienceNoFilter to documents available to an audience label. Public documents are included.
analyst_statusNoFilter by research analyst_status. Requires metadata reindex.
as_of_dateNoEvaluate effective_date and valid_until against YYYY-MM-DD.
canonical_sourceNoFilter by canonical source marker or value. Requires metadata reindex.
claim_idNoFilter by research claim_id. Requires metadata reindex.
confidenceNoFilter by research confidence (e.g. high, medium, low). Requires metadata reindex.
entity_idNoFilter to documents that mention a specific entity UUID.
entity_typeNoFilter to documents that mention entities of this type (e.g. person, organization).
include_codeNoInclude code_file results from the code_doc pack alongside documentation. Default false (docs only).
kindNoFilter by node kind: document, heading, definition, tag. Code files (code_doc pack) are excluded by default; pass kind=code_file or include_code=true to surface them.
limitNoMax results (default 10)
projectNoWorkspace mode only: scope results to a single project by name (the directory name shown in docgraph_status). Omit to query all projects. No-op in single-store mode.
queryYesSearch terms
sensitivityNoFilter by sensitivity (e.g. public, internal, confidential, restricted). Requires metadata reindex.
source_typeNoFilter by research source_type (e.g. primary, secondary, internal). Requires metadata reindex.
statusNoFilter by governance status (e.g. approved, draft, superseded). Requires metadata reindex.
Behavior2/5

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

Annotations indicate destructiveHint=true and idempotentHint=false, which are unusual for a search tool, but the description does not address these traits. The description focuses on result path handling but omits behavioral side effects.

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?

Description is a single paragraph that front-loads the core purpose and provides essential details in a compact form. A bit dense but no wasted sentences.

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 16 parameters and no output schema, the description covers search function, sibling differentiation, filters, and result handling. Lacks explanation of destructive behavior, but otherwise adequate for the complexity.

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?

Schema coverage is 100%, but description adds value by explaining filter usage and result path format (suffix stripping, parent document path). This helps agents use parameters correctly 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?

Clearly states it performs full-text search across indexed Markdown documents and returns matching documents with headings and snippets. Differentiates from sibling docgraph_context by specifying it combines search with structure.

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 advises when to use this tool vs docgraph_context, and instructs to use governance and research filters. Also provides specific guidance on stripping path suffixes for downstream tools.

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/Detective-XH/DocGraph'

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