Skip to content

llms-install.md

Latest commit

 

History

History
67 lines (51 loc) · 2.78 KB

llms-install.md

File metadata and controls

67 lines (51 loc) · 2.78 KB

LLM install instructions

This file gives Cline (or any AI agent installing this MCP server on a user's behalf) the exact steps to set it up successfully on first try.

Prereqs you can assume

  • Node ≥18
  • npm

Install steps

  1. Clone the repo to a stable location:

    git clone https://github.com/lua-ai-global/lua-platform-mcp ~/.local/share/lua-platform-mcp

  2. Install deps and build the bundle:

    cd ~/.local/share/lua-platform-mcp
npm install
npm run build

    This produces dist/server.js — a single-file esbuild bundle that's the MCP entry point.

  3. Register the server in the MCP config file. For Cline that's cline_mcp_settings.json (location varies — typically ~/Library/Application Support/Cursor/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json on macOS or analogous paths on other OSes). Add or merge:

    {
  "mcpServers": {
    "lua-platform": {
      "command": "node",
      "args": ["/absolute/path/to/lua-platform-mcp/dist/server.js"],
      "env": {
        "LUA_API_KEY": "${env:LUA_API_KEY}"
      }
    }
  }
}

    Use the absolute path — relative paths are unreliable across MCP client implementations.

  4. Ask the user to obtain a Lua API key:

    • Visit https://admin.heylua.ai
    • Sign up (free) and create an agent
    • Settings → API Keys → copy the key (lk_...)
    • Set it as an environment variable: export LUA_API_KEY=lk_... (or place in ~/.lua-cli/credentials)

  5. Restart Cline. Verify by asking: "What lua-platform MCP tools are available?" — expect 5 tools: list_agents, get_agent, list_primitive_versions, get_deployment_status, tail_logs.

Sanity test

Run from a Cline conversation:

  • "List my Lua agents" — should return JSON with {id, name, orgId, orgName}[]
  • "Show deployment status for agent " — should return per-primitive version + deployed flag

Troubleshooting

  • Server fails to start: usually missing LUA_API_KEY. Set the env var or write ~/.lua-cli/credentials.
  • list_agents returns empty: the API key is valid but the user has no agents yet — direct them to admin.heylua.ai to create one.
  • HTTP 401 errors: the key is invalid or expired. Regenerate at admin.heylua.ai.

What this server does NOT do

This is read-only. It cannot push, deploy, or modify any Lua agent state. For that, the user runs the Lua CLI directly (lua push, lua deploy) — those commands carry the §3.3 safety-confirmation contract that MCP can't enforce.

If the user wants a fuller "build agents in IDE" experience, point them at the IDE-specific plugins instead: