Skip to main content
Glama

workspace.rag_query

Run a notebook-scoped RAG query over indexed sources (codegen/SDK).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "workspace_id": "<workspace_id>",
      "query": "<query>"
    },
    "name": "workspace.rag_query"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryYes
doc_scopeNo
workspace_idYesWorkspace (notebook) UUID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.6/5.0
Behavior2/5

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

With no annotations, the description carries the full behavioral burden, yet it says nothing about cost, latency, or whether results cite sources. The parenthetical '(codegen/SDK)' is cryptic and does not disclose what it means for behavior — whether the query is answered in code generation mode or something else.

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

Conciseness3/5

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

It is a single front-loaded sentence with no filler, which is good, but the trailing '(codegen/SDK)' token adds confusion rather than clarity. Brevity here reads as under-specification rather than discipline.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a three-parameter retrieval tool with no annotations, no output schema, and only 33% schema coverage, the description should explain the scope parameter and the nature of results. Neither is covered, so an agent must guess on invocation details.

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

Parameters2/5

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

Only 33% of parameters carry a schema description (workspace_id), and the description does not compensate: it never explains 'query' phrasing expectations or what 'doc_scope' filters against (file paths? source IDs?). Two of three parameters are semantically undocumented.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: 'Run a ... RAG query over indexed sources', scoped to a notebook. An agent can grasp what the tool does, but the definition never distinguishes it from the sibling workspace.search_query, leaving the choice between the two to the schema or guesswork.

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

Usage Guidelines2/5

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

The only implied precondition is that sources must already be indexed; there is no statement of when to prefer this over workspace.search_query or workspace.chat, and no exclusions. The agent gets no routing guidance beyond the tool name.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources