Skip to main content
Glama
Sign In
aiterm-mcp

aiterm-mcp

by kitepon
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Local

diagnostics

Checks Factory environment state and returns read-only, machine-readable JSON with safe vocabulary, including parent delivery-hook registration; run aiterm-setup when caller status is setup_required.

Instructions

Factory 向け read-only 診断。安全な状態語彙だけを機械可読 JSON で返す（PTY 内容・認証情報・path・環境値は返さない）。2つ目のtextは親配送hook（Claude Code・Cursor）の登録状態で、caller_status が setup_required なら呼出元からのagent送信は拒否される。aiterm-setup を実行する。

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "diagnostics"
  }
}

Input Schema

NameRequiredDescriptionDefault
formatNo既定v1は既存の固定fieldを維持。v2はPTY診断の安全なreason_codeを含む。

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.63.7
    • addedInput schema / properties / format
      Added value: +{
+  "description": "既定v1は既存の固定fieldを維持。v2はPTY診断の安全なreason_codeを含む。",
+  "enum": [
+    "v1",
+    "v2"
+  ],
+  "type": "string"
+}
  2. First observedv0.20.2

TDQS

A3.7/5.0
Behavior4/5

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

With no annotations supplied, the description carries the full burden and does so well: it declares the operation read-only, enumerates exactly which sensitive categories are withheld from the response, and explains that the second text field reports parent delivery hook registration state. It does not describe error behavior or failure modes, which keeps it short of 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?

The read-only guarantee and redaction scope are front-loaded, then the response interpretation, then the remediation step. Every sentence carries information. The closing imperative (run aiterm-setup) is telegraphic and slightly abrupt given it is conditional on caller_status, but nothing is padding.

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?

There is no output schema, yet the description explains the return contract (machine-readable JSON, safe vocabulary, meaning of the second text field, how caller_status should be interpreted). For a single-optional-parameter diagnostic this is close to sufficient; only error and partial-failure behavior are unaddressed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and the single format enum is fully documented in-schema (v1 keeps fixed fields, v2 adds safe PTY reason_code). The description adds output-shape meaning (the second text field) but nothing about the format parameter itself, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: read-only diagnostics for Factory that return safe state vocabulary as machine-readable JSON. It also scopes what is excluded (PTY contents, credentials, paths, environment values), which separates it from observation tools like pty_observe or pty_read. It does not name a sibling explicitly, but the read-only/status-only framing is unambiguous.

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

Usage Guidelines3/5

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

Usage context is implied rather than stated: the caller learns that a setup_required caller_status means agent sending is rejected and that aiterm-setup should be run. There is no explicit statement of when to call this instead of sibling diagnostics-adjacent tools, nor of prerequisites before calling it.

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