Skip to main content
Glama

FlowCastle

by ai.flowcastle
OverviewDiscussionsAdmin

get_module_details

Read-only

Return everything needed to use one module: action input fields and their types, trigger configuration, manual setup fields (credentials an operator must fill in the dashboard), and references to already-installed actions. Read-only. Call get_module_catalog first to obtain moduleKey, and call this again after install_module to read the installed action references you need when drafting actions. An unknown moduleKey does not raise — the response carries an error string plus availableModules listing valid keys and versions. The answer opens with actionIndex (every action, one line each); pass actions to read only some, and read omittedActions when not every action fit.

Input Schema

NameRequiredDescriptionDefault
actionsNoAction template keys to read in full, from the answer's actionIndex. Omit for every action that fits; the ones that do not fit are named in omittedActions.
moduleKeyYesRequired. The module's stable key exactly as returned by get_module_catalog (not its display name).
applicationIdNoApplication (workspace) id. Optional: an application-scoped key (app_...) defaults to its own application, but a personal key (usr_...) has no default and omitting it fails with MCP_APPLICATION_REQUIRED. Call list_applications to get the id.
moduleVersionNoPin a specific version. Omit to resolve the installed version when the module is installed, falling back to the marketplace entry for that key.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / actions
      Added value: +{
+  "description": "Action template keys to read in full, from the answer's actionIndex. Omit for every action that fits; the ones that do not fit are named in omittedActions.",
+  "items": {
+    "type": "string"
+  },
+  "type": "array"
+}
  2. Changed3 schema fields changed
    • addedInput schema / properties / applicationId / description
      Added value: +"Application (workspace) id. Optional: an application-scoped key (app_...) defaults to its own application, but a personal key (usr_...) has no default and omitting it fails with MCP_APPLICATION_REQUIRED. Call list_applications to get the id."
    • addedInput schema / properties / moduleKey / description
      Added value: +"Required. The module's stable key exactly as returned by get_module_catalog (not its display name)."
    • addedInput schema / properties / moduleVersion / description
      Added value: +"Pin a specific version. Omit to resolve the installed version when the module is installed, falling back to the marketplace entry for that key."
  3. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and destructiveHint=false, so safety is covered. The description still adds non-obvious behavior: an unknown moduleKey does not raise but returns an `error` string plus `availableModules`, and results are truncated with omissions surfaced via omittedActions. It does not mention auth/permission or versioning behavior beyond what the schema says, keeping it below a 5.

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?

Front-loaded with what is returned, then prerequisites, then error behavior, then response structure — a sensible order with no filler. It is dense and slightly overloaded with backticked field names in the final sentences, which costs it a point but every sentence carries information.

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

Completeness5/5

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

There is no output schema, so the description must explain return shape, and it does: actionIndex first, actions for selective full reads, omittedActions for truncation, and error/availableModules on failure. Combined with the annotated read-only profile, an agent has everything needed to call and interpret it.

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%, so baseline is 3. The description still adds operational meaning to `actions` (read only some actions, omitted ones appear in omittedActions) and ties moduleKey to the catalog output, which the schema only partially conveys.

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?

States a specific verb and resource ('Return everything needed to use one module') and enumerates the content: action input fields and types, trigger configuration, manual setup fields, installed action references. This clearly separates it from get_module_catalog (which returns keys) and get_action_schema (which covers a single action).

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?

Gives explicit ordering rules: call get_module_catalog first to obtain moduleKey, and call this tool again after install_module to read installed action references. It also names the alternative/next-step tools rather than leaving routing to inference.

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

All FlowCastle toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources