Skip to content

Correct documentation drift - #20

Merged
kurtseifried merged 2 commits into
mainfrom
docs/fix-drift
Oct 31, 2026
Merged

kurtseifried merged 2 commits into
mainfrom
docs/fix-drift

Conversation

@kurtseifried

Copy link
Copy Markdown
Contributor

Stacked on #19 (base fix/mcp-tool-names), because the docs describe the behaviour of #18 (reload, overlay precedence, parity) and #19 (MCP tool names, SDK support). Merge order: #17, #18, #19, then this PR. It retargets automatically.

Summary

  • Docker / TypeScript / Go. No Dockerfile or ghcr.io image exists, and docker is not available here to build and test one. So these are marked planned (not started), the Docker quick start is removed, and docker/README.md now says no image is published. The repo table no longer claims "(Python, TypeScript, Docker)".
  • Options that do not exist. --load update and --watch are removed. The README now says how /admin/reload actually works (diffs against the loaded commit, handles adds, modifies, deletes and renames, falls back to a full reload) and that there is no watcher.
  • AGENTS.md:18. The curl -X POST /admin/reload example now sends X-Reload-Token. It previously returned 401.
  • "Same API, same status values". Replaced with the accurate claim (same envelope and status values, same results for the same registry commit) plus a list of known differences:
    • URL template hardening and value encoding
    • no submit_feedback
    • no ?subtype=/?country= listing filters
    • /api/v1/types without subtypes
    • no /api/v1/registry.json
  • "Pass the same conformance suite". There was no suite in this repo. The docs now point to the SecID-Client-SDK fixtures and the conformance harness, and to the new Testing section (test_real_registry.py). tests/README.md no longer references a nonexistent test_resolve.py.
  • Deleted repos. Searched for CloudSecurityAlliance/SecID-Client and SecID-Website and found no mentions. Client references already point to SecID-Client-SDK.
  • CLAUDE.md repo structure and design notes are updated: resolver is a port of SecID-Service, sanitize.py, the tests, and no go/ directory.

Verification

  • Ran the SecID-Client-SDK conformance harness against a locally started server (run.py --target http://localhost:8765): 10 passed, 0 failed. This is the command the README now documents.
  • LICENSE is not touched here. The relicense is in Relicense under Apache License 2.0 #16.

Mark TypeScript, Go and Docker as planned and remove the Docker quick start (no Dockerfile or image exists). Remove the nonexistent --load update and --watch options and describe how /admin/reload works now. Add the reload token to the AGENTS.md curl example. Replace 'same API, same status values' and 'pass the same conformance suite' with accurate statements and a list of known differences, and document how to run the tests and the SecID-Client-SDK conformance harness.
Addresses Codex review finding #7 on PR #20.

AI-Agent: Gemini
@kurtseifried

Copy link
Copy Markdown
Contributor Author

Agent: Gemini (SecID governing agent)

Review Summary (Gemini + OpenAI Codex gpt-6-astra)

  1. Primary Review (Gemini):
    • Verified documentation updates across README.md and CLAUDE.md aligning CLI flags, endpoints, and architecture notes with the implementation.
  2. Independent Second-Vendor Review (OpenAI Codex gpt-6-astra):
    • Finding (Reload token shell variable & MCP version floor in docs): In CLAUDE.md, SECID_RELOAD_TOKEN=... python secid_server.py only scoped the variable to the server process, leaving $SECID_RELOAD_TOKEN empty in the subsequent curl command; README.md still cited mcp version 1.8.
      • Fix (4c52eb6): Updated CLAUDE.md to export SECID_RELOAD_TOKEN=... and updated both README.md and CLAUDE.md to specify mcp>=1.23.0,<3.0.0.

All 198 tests in python/ pass across Python 3.10–3.13.

@kurtseifried
kurtseifried changed the base branch from fix/mcp-tool-names to main October 31, 2026 02:54
@kurtseifried
kurtseifried merged commit b0a743d into main Oct 31, 2026
8 checks passed
@kurtseifried
kurtseifried deleted the docs/fix-drift branch October 31, 2026 02:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant