Skip to main content
Glama
mechanic-mcp
by lightward

mechanic-mcp

Mechanic MCP server for the task library and docs. Built for writing and customizing Mechanic tasks (Shopify automation app: https://apps.shopify.com/mechanic). Offline by default (bundled data), serving public URLs for tasks (https://tasks.mechanic.dev) and docs (https://learn.mechanic.dev).

User guide

  • Requirements: Node.js 18+, MCP-capable client (Cursor, Claude Desktop, Codex, Gemini CLI, etc.).

  • What you can ask: find tasks; fetch task code (subscriptions + script/JS blocks); find docs; suggest similar tasks; get doc content; help writing or customizing Mechanic tasks.

  • Setup (use npx @lightward/mechanic-mcp@latest):

    • Cursor:

      {
        "mcpServers": {
          "mechanic-mcp": {
            "command": "npx",
            "args": ["-y", "@lightward/mechanic-mcp@latest"]
          }
        }
      }
    • Claude Desktop:

      {
        "mcpServers": {
          "mechanic-mcp": {
            "command": "npx",
            "args": ["-y", "@lightward/mechanic-mcp@latest"]
          }
        }
      }
    • Codex (~/.codex/config.toml):

      [mcp_servers.mechanic-mcp]
      command = "npx"
      args = ["-y", "@lightward/mechanic-mcp@latest"]
    • Gemini CLI: same JSON as Cursor/Claude.

  • Tools:

    • search_tasks: returns public URL, tags, subscriptions/subscriptions_template, options.

    • search_docs: returns public URL/sourceUrl.

    • get_task (tasks only): script + subscriptions + options + JS blocks; not full JSON.

    • get_doc (docs only): full markdown.

    • similar_tasks: related tasks by tags/subscriptions/title.

    • refresh_index: rebuild (not needed for packaged data).

  • Usage notes: cite public URLs (no local paths/.md); prefer GraphQL in code; when sharing code, return subscriptions + script/JS (relevant bits), not full JSON.

Related MCP server: Shopify Liquid MCP Server

For maintainers

  • Bundled data: dist/data/index.json.gz, records.json.gz, manifest.json (users don’t need source repos).

  • Regenerate (if needed):

    MECHANIC_DOCS_PATH=/path/to/mechanic-docs MECHANIC_TASKS_PATH=/path/to/mechanic-tasks npm run build:data
    npm run build
  • Tests: npm run test:smoke, npm run test:smoke-doc, npm run test:smoke-task.

  • Publish: bump version, npm publish (use --access public for scoped packages).

Env (optional)

  • MECHANIC_DATA_PATH (default dist/data), MECHANIC_DOCS_PATH, MECHANIC_TASKS_PATH, repo URLs/branches, sync interval.

Runtime

  • Loads bundled index/records from MECHANIC_DATA_PATH; refresh_index rebuilds if you opt in. Stdio transport; TF-IDF search with fuzzy + pagination; no network calls for search/resources.

Available Tools

6 tools
get_docA

Docs only: fetch by id/path (use search_docs to find ids).

Inputs: id (required). Returns: id, url, path, title, +1 more

get_taskA

Tasks only: fetch by handle/id with full payload (script, options, subscriptions).

Inputs: id (required). Returns: id, url, name, tags, +7 more

refresh_indexB

Refresh and rebuild the index from source data

Inputs: no named parameters.

search_docsD

Search Mechanic docs (generated task documentation)

Inputs: query (required), sort, tags, fuzzy, +5 more. Returns: items, nextOffset

search_tasksC

Search Mechanic tasks

Inputs: query (required), sort, tags, fuzzy, +5 more. Returns: items, nextOffset

similar_tasksC

Find similar tasks by tags/subscriptions/title content.

Inputs: handle (required), limit. Returns: items

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    C2.9/5.0

    Scored across 6 tools

    Disambiguation4/5

    search_tasks and similar_tasks overlap somewhat in intent, but descriptions clarify search vs similarity lookup. get_task/get_doc and search_tasks/search_docs form distinct retrieval pairs, and refresh_index is clearly administrative.

    Naming Consistency4/5

    Most tools follow a verb_noun pattern (search_tasks, get_task, search_docs, get_doc, refresh_index). similar_tasks is the lone exception, reading as adjective_noun rather than an action.

    Tool Count5/5

    Six tools is well-scoped for a task/document search and retrieval server. Each tool covers a distinct operation without unnecessary redundancy.

    Completeness4/5

    The surface covers search, direct retrieval, similarity lookup, and index refresh for tasks and docs. Write operations are absent, but the server appears intended as read-only retrieval, so this is a minor scope gap rather than a critical omission.

    Maintenance

    ActivityStale
    ResponsivenessOutdated data

    Related MCP Connectors

    Related MCP Servers

    • F
      license
      A
      quality
      D
      maintenance
      Provides offline search and retrieval of Magento 2 GraphQL API documentation with 8 specialized tools for finding queries, mutations, types, tutorials, and code examples across 350+ locally indexed markdown files.
      8
      9
      -
    • A
      license
      Not graded
      quality
      C
      maintenance
      Connects Claude, ChatGPT, Cursor, or any MCP client to a Shopify store, enabling read-only access to themes, Liquid files, catalogue data, and store configuration through 122 tools.
      2
      Apache 2.0
    • A
      license
      A
      quality
      B
      maintenance
      Enables developers to search official documentation offline, explain configuration files, look up CLI commands and REST/GraphQL APIs, and scaffold modules, plugins, observers, controllers, and database tables without network access or credentials.
      10
      151 npm
      MIT