Skip to main content
Glama

review.version

Check the Re:VIEW CLI version to ensure proper setup for validating and correcting manuscript files, preventing common writing errors.

Instructions

Return Re:VIEW CLI version (prefers bundle exec).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
cwdYes

Implementation Reference

  • Handler for the 'review.version' tool: runs 'review --version' via withBundle helper and returns the version string as JSON.
    case "review.version": {
      const { stdout } = await withBundle(args.cwd as string, ["review", "--version"]);
      return { 
        content: [
          { type: "text", text: JSON.stringify({ version: stdout.trim() }) }
        ]
      };
    }
  • Input schema for 'review.version' tool requiring 'cwd' parameter.
    inputSchema: { 
      type: "object", 
      properties: { cwd: { type: "string" } }, 
      required: ["cwd"] 
    }
  • src/index.ts:253-261 (registration)
    Tool definition object for 'review.version' included in the tools array returned by listTools.
    {
      name: "review.version",
      description: "Return Re:VIEW CLI version (prefers bundle exec).",
      inputSchema: { 
        type: "object", 
        properties: { cwd: { type: "string" } }, 
        required: ["cwd"] 
      }
    },
  • src/index.ts:425-429 (registration)
    ListTools request handler registration that exposes the tools list including 'review.version'.
    server.setRequestHandler(ListToolsRequestSchema, async () => {
      return {
        tools: tools
      };
    });
  • Helper function 'withBundle' used by the 'review.version' handler to prefer bundled 'review' command execution.
    async function withBundle(cwd: string, argv: string[]) {
      try {
        // If Bundler works, prefer bundle exec to respect project Gemfile
        await execp("bundle", ["exec", "ruby", "-v"], { cwd, timeout: 8000 });
        return await execp("bundle", ["exec", ...argv], { cwd, timeout: 60000, maxBuffer: 10*1024*1024 });
      } catch {
        // Fallback to direct command
        const [cmd, ...rest] = argv;
        return await execp(cmd, rest, { cwd, timeout: 60000, maxBuffer: 10*1024*1024 });
      }
    }
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It discloses the behavioral trait of preferring 'bundle exec' for execution, which adds context about how the tool runs. However, it lacks details on output format, error handling, or other behavioral aspects like whether it's read-only or has 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.

Conciseness5/5

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

The description is a single, efficient sentence that front-loads the core purpose ('Return Re:VIEW CLI version') and adds a useful operational note ('prefers bundle exec') without any waste. Every word earns its place.

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 tool's low complexity (single parameter, no output schema, no annotations), the description is reasonably complete. It explains what the tool does and adds execution context. However, it could be more complete by briefly mentioning the return value (e.g., version string) or error cases, though the simplicity mitigates this gap.

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?

The input schema has one parameter 'cwd' with 0% description coverage, so the schema provides no semantic information. The description does not mention parameters at all, but since there is only one parameter, the baseline is high. The tool's purpose is simple (return version), so the lack of parameter explanation is less critical, but it doesn't add 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 specific action ('Return') and resource ('Re:VIEW CLI version'), and distinguishes it from siblings by focusing on version retrieval rather than build, lint, or security operations. It adds the operational detail 'prefers bundle exec' which further specifies the execution context.

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

Usage Guidelines4/5

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

The description implies usage context by mentioning 'prefers bundle exec', suggesting it's for checking the CLI version in a Ruby/bundler environment. However, it does not explicitly state when to use this tool versus alternatives (e.g., for debugging or setup verification) or name specific sibling tools as alternatives.

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/dsgarage/ReviewMCP'

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