check-syncro-apis

Check Syncro API for new endpoints

You are auditing the SyncroMSP MCP server in this repository for API coverage gaps. The Syncro OpenAPI spec at https://api-docs.syncromsp.com/swagger.json is the source of truth. Your local cached copy lives at docs/swagger.json. The repository's tools live under src/domains/*.ts.

If the user passed --apply (check $ARGUMENTS), implement the additions after producing the report. Otherwise, produce only the report and ask whether to proceed.

Step 1 — Fetch the live spec

Use a temp file outside the repo so we don't dirty the worktree before deciding to update:

TMP_SWAGGER="${TMPDIR:-/tmp}/syncro-swagger-live.json"
curl -fsSL -o "$TMP_SWAGGER" https://api-docs.syncromsp.com/swagger.json
test -s "$TMP_SWAGGER" || { echo "Failed to download spec"; exit 1; }

If the download fails, stop and tell the user.

Step 2 — Diff against the cached spec

Run a Python diff covering three categories of drift:

python3 - <<'PY'
import json, os
tmp = os.environ.get("TMPDIR", "/tmp").rstrip("/") + "/syncro-swagger-live.json"
old = json.load(open("docs/swagger.json"))
new = json.load(open(tmp))

old_paths = old.get("paths", {})
new_paths = new.get("paths", {})

added_paths = sorted(set(new_paths) - set(old_paths))
removed_paths = sorted(set(old_paths) - set(new_paths))

method_diffs = []
for p in sorted(set(old_paths) & set(new_paths)):
    om, nm = set(old_paths[p]), set(new_paths[p])
    if om != nm:
        method_diffs.append((p, sorted(om), sorted(nm)))

def get_params(spec_paths, path, method):
    op = spec_paths.get(path, {}).get(method, {})
    return {x["name"]: x.get("description", "") for x in op.get("parameters", [])}

def get_body_props(spec_paths, path, method):
    op = spec_paths.get(path, {}).get(method, {})
    body = op.get("requestBody", {}).get("content", {}).get("application/json", {}).get("schema", {})
    return set((body.get("properties") or {}).keys())

param_drift, body_drift = [], []
for p in sorted(set(old_paths) & set(new_paths)):
    for m in set(old_paths[p]) & set(new_paths[p]):
        added_params = set(get_params(new_paths, p, m)) - set(get_params(old_paths, p, m))
        if added_params:
            param_drift.append((p, m, sorted(added_params)))
        if m in ("post", "put", "patch"):
            added_body = get_body_props(new_paths, p, m) - get_body_props(old_paths, p, m)
            if added_body:
                body_drift.append((p, m, sorted(added_body)))

print("=== ADDED PATHS ===")
for p in added_paths:
    print(f"  {p} -> {sorted(new_paths[p].keys())}")
print("\n=== REMOVED PATHS ===")
for p in removed_paths:
    print(f"  {p}")
print("\n=== METHOD CHANGES ===")
for p, o, n in method_diffs:
    print(f"  {p}: {o} -> {n}")
print("\n=== ADDED QUERY PARAMS ON EXISTING ENDPOINTS ===")
for p, m, params in param_drift:
    print(f"  {m.upper()} {p}: {', '.join(params)}")
print("\n=== ADDED REQUEST-BODY FIELDS ON EXISTING ENDPOINTS ===")
for p, m, fields in body_drift:
    print(f"  {m.upper()} {p}: {', '.join(fields)}")
PY