Skip to main content
Glama

Get J3 Module

get_j3_module

Fetch a Journal3 module by ID to return its full JSON configuration for OpenCart store inspection or editing.

Instructions

Get full Journal3 module data for a single module by ID. Returns full JSON config — can be large for complex modules.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
module_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.7.0

TDQS

A3.7/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden. It usefully warns that the result is 'full JSON config' and 'can be large for complex modules', but it does not state read-only status, permission requirements, or error 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 two tight sentences, front-loaded with the core action and followed by a useful size warning. No sentence is wasted.

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 single-parameter read tool with an output schema, the description covers the essential action and a relevant output-size caveat. It is slightly thin on parameter format and alternatives, but it is largely complete for this complexity level.

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?

Schema description coverage is 0%, so the description must compensate for the undocumented module_id parameter. It only says 'by ID', which adds minimal meaning beyond the parameter name and type already present in 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 states a specific verb and resource: 'Get full Journal3 module data'. It also scopes the operation to 'a single module by ID', which clearly distinguishes it from the sibling list tool get_modules.

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?

Usage is implied by 'for a single module by ID', so an agent can infer this is for fetching one known module. However, the description never explicitly says when to use this instead of get_modules or update_j3_module, and it offers no when-not guidance.

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