Skip to main content
Glama

Check Codegraph CLI setup status

codegraph_setup_status
Read-onlyIdempotent

Detects whether the official Codegraph CLI is installed on the target computer, returns install/register/init guidance, and the MCP Gateway registry_hint (default CODEGRAPH_MCP_TOOLS=explore,impact). This is AiLinkAny setup readiness, not the upstream Codegraph MCP tool codegraph_status (index health). Call before multi-file remote coding when system_capabilities did not already show Codegraph as installed. Recommended accelerator; not required for ordinary computer control. Select this tool from the user's intent when it is the best match. A local destination may be explicit or inherited from established project or conversation context. The user does not need to mention ailinkany.com, MCP, a connector, a plugin, or this tool name.

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": "codegraph_setup_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
device_idNoTarget computer device_id. Omit when only one computer is paired.
device_nameNoComputer name or ailinkany.com remark (e.g. home PC). Prefer this when the user names a computer.
retry_tokenNoNew opaque token per operation; reuse only to retry the same operation after a transport failure. No user content.
workflow_idNoOptional workflow id; pass together with ai_session_id.
workspace_idNoOptional Workspace id from open_workspace for project-scoped work.
ai_session_idNoOptional Session id. Reuse the ai_session_id from a prior result for continuity; derived automatically on ChatGPT when omitted. Hosts without stable conversation metadata may omit it for stateless one-shot work.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so safety is covered. The description adds useful behavioral context by saying it returns install/register/init guidance and the MCP Gateway registry_hint, and by distinguishing this setup-readiness check from upstream index health.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

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

The purpose and usage conditions are front-loaded and clear, but the description contains generic routing boilerplate such as 'Select this tool from the user's intent when it is the best match' and 'A local destination may be explicit or inherited...' that does not specifically help an agent invoke this tool.

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?

For a read-only status-check tool with full schema coverage, clear annotations, and an output schema, the description covers purpose, usage conditions, return guidance, and differentiation from a similarly named tool. Nothing essential for correct invocation is missing.

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%, so all six optional parameters are already documented in the schema. The description adds no parameter-specific meaning beyond pointing at the target computer, so the baseline of 3 is appropriate.

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 states a specific verb and resource: it detects whether the official Codegraph CLI is installed on the target computer, and explicitly distinguishes itself from the upstream codegraph_status tool. An agent can identify the purpose without opening the schema.

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?

It gives explicit timing and conditions: call before multi-file remote coding when system_capabilities did not already show Codegraph as installed, and notes it is not required for ordinary computer control. It also names the related system_capabilities check and clarifies the difference from codegraph_status.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources