Skip to main content
Glama
Sign In
arcane-cli-mcp

arcane-cli-mcp

by joshnewman17
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

arcane_api_get

Read-only

Fetch read-only JSON from Arcane REST API GET paths when arcane-cli lacks the needed data, using server-managed API-key auth and optional field filtering.

Instructions

Read-only escape hatch: GET a path on the Arcane REST API and return the JSON. Use it only for data that arcane-cli does not expose. Every request carries the server's API key; you never need to send one. Only GET is supported, and path must start with /api/ (no full URLs, no '..').

fields (top-level names or dotted paths) keeps only those fields of each item, or of the single object. With compact=true (default), environment container/project/image/volume/network lists use the same summaries as arcane_run, and a single project drops updateInfoByRef (it repeats serviceUpdates).

The OpenAPI 3.1 spec is at /api/openapi.json. Fetch it, with care because it is large, to find paths. Environment-scoped paths look like /api/environments/{id}/projects.

Examples:

  • {"path": "/api/environments"}

  • {"path": "/api/environments/0/projects", "query": {"limit": 5}}

  • {"path": "/api/environments/0/projects", "fields": ["name", "status", "updateInfo.hasUpdate"]}

  • {"path": "/api/openapi.json"}

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "path": "<path>"
    },
    "name": "arcane_api_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes
queryNo
fieldsNo
compactNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only declare readOnlyHint=true and openWorldHint=false; the description adds substantial context beyond that: the server's API key is injected automatically, only GET is supported, and path is constrained to /api/ with no full URLs or '..' traversal. It further discloses the compact-mode reshaping behavior and the specific field dropped for single projects, which an agent could not infer elsewhere.

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-loads the escape-hatch framing and constraints, then moves to field filtering, then discovery, then concrete examples. Dense but each sentence carries content; the parenthetical about updateInfoByRef is slightly granular but still operationally relevant.

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?

An output schema exists, so return values need not be explained, and the description focuses on what the schema cannot convey: auth handling, method restriction, path validation, and response shaping. Worked examples cover listing, query filtering, field selection, and spec discovery.

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?

With 0% schema description coverage the description must carry the parameter meaning, and it largely does: path constraints, fields as top-level names or dotted paths, and compact defaulting to true with its effect on list versus single-object responses. The query parameter is only demonstrated in examples (limit: 5) rather than explained, leaving one gap.

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?

Opens with a specific verb+resource pair: "GET a path on the Arcane REST API and return the JSON." It immediately frames itself as an escape hatch relative to arcane-cli, so an agent can tell it apart from arcane_run and the higher-level siblings without inspecting schemas.

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 an explicit use-case boundary: "Use it only for data that arcane-cli does not expose," which names the alternative tool class and the condition that selects this one. It also tells the agent to consult /api/openapi.json to discover valid paths, closing the loop on how to proceed.

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

Deploy Server

Other Tools