Skip to content

mcp.md

Latest commit

 

History

History
52 lines (37 loc) · 1.39 KB

mcp.md

File metadata and controls

52 lines (37 loc) · 1.39 KB
Raw

GhostAPI MCP Setup

GhostAPI ships with a local stdio MCP server so coding agents can inspect and control the local API world.

Start MCP

npx @yiaany/ghostapi mcp

Universal Config

{
  "mcpServers": {
    "ghostapi": {
      "command": "npx",
      "args": ["-y", "@yiaany/ghostapi", "mcp"]
    }
  }
}

Generate Client Snippets

npx @yiaany/ghostapi setup --write

This writes copy-ready local snippets under .ghostapi/agent-configs/ and project instructions for supported agent clients.

Tools

Tool Purpose
inspect_state Read sanitized local API objects from the configured GhostAPI data directory.
get_traffic_logs Inspect recent captured API traffic.
set_api_behavior Force a deterministic local response for method + path.
toggle_chaos_mode Enable or disable local latency and error injection.

The HTTP server and MCP process must use the same GHOSTAPI_DATA_DIR to share state, behaviors, and persisted Fault Lab configuration. Updates use local inter-process locking; this is not distributed coordination for network filesystems.

Agent Prompt

Use the GhostAPI MCP server.

Keep all third-party API calls local on http://127.0.0.1:8080.
Do not call real providers.

Use GhostAPI MCP tools to inspect state, read traffic logs, configure deterministic responses, and test failure scenarios.