Skip to content

fix(docs): correct hallucinations and wrong values in tutorials#334

Merged
imran-siddique merged 2 commits into
mainfrom
fix/tutorial-accuracy
Jun 22, 2026
Merged

fix(docs): correct hallucinations and wrong values in tutorials#334
imran-siddique merged 2 commits into
mainfrom
fix/tutorial-accuracy

Conversation

@imran-siddique

Copy link
Copy Markdown
Contributor

Summary

Systematic audit of all 7 tutorial files against actual source code found 9 categories of issues. All fixed.

Fixes

File Issues fixed
All 7 files pip install cmcp-gatewaypip install cmcp-runtime (wrong PyPI package name)
cedar-policy-walkthrough.md cedar-policy-analysis (nonexistent pip package) → cedar-policy-cli (Rust crate via cargo); added cMCP:: namespace to all Cedar Action and Resource references
response-inspection.md Removed fabricated inspection_config_path config key (not in _KNOWN_TOP_KEYS, causes ConfigError); fixed all pattern names from underscore to hyphen-separated to match patterns_v1.json; removed conv_reset (does not exist)
tls-pinning.md Fixed sentinel behavior description (warns + falls back to CA, does not fail closed); fixed catalog hash snippet to use canonical JSON re-serialization matching catalog/loader.py _catalog_hash(), not raw file bytes
tee-attestation.md Removed CMCP_AMD_SEV_SNP_REPORT_PATH export (env var does not exist; path hardcoded in sev_snp.py); fixed measurement prefix sha256:sha384: in sample output and expected_measurement config

Test plan

  • pip install cmcp-runtime resolves correctly
  • Cedar policy snippets pass cedar validate with the cMCP:: namespace
  • Pattern names in response-inspection tutorial match patterns_v1.json
  • Catalog hash snippet produces the same value as the runtime

🤖 Generated with Claude Code

imran-siddique and others added 2 commits June 22, 2026 12:45
Fixes found by systematic cross-check of every tutorial against
the actual source code and config schema.

Changes per file:

quickstart.md
- cmcp-gateway → cmcp-runtime (package name)

verifying-a-trace-claim.md
- cmcp-gateway → cmcp-runtime; fix cmcp_verify attribution comment

cedar-policy-walkthrough.md
- cmcp-gateway → cmcp-runtime
- cedar-policy-analysis (nonexistent pip package) → cedar-policy-cli
  (real Rust crate: cargo install cedar-policy-cli)
- Add cMCP:: namespace to all Action and Resource references in Cedar
  policy snippets (bare Action::"call_tool" is rejected by the schema)

response-inspection.md
- cmcp-gateway → cmcp-runtime
- Remove fabricated inspection_config_path config key (not in
  _KNOWN_TOP_KEYS; would cause ConfigError at startup)
- Fix all pattern names: underscore-separated → hyphen-separated to
  match patterns_v1.json; remove conv_reset (does not exist)

tls-pinning.md
- cmcp-gateway → cmcp-runtime
- Fix sentinel behavior: runtime warns and falls back to CA
  verification (does not fail closed as tutorial claimed)
- Fix catalog hash computation: use json.dumps canonical form
  not raw file bytes (matches catalog/loader.py _catalog_hash())

tee-attestation.md
- cmcp-gateway → cmcp-runtime
- Remove CMCP_AMD_SEV_SNP_REPORT_PATH export (env var does not exist;
  device path is hardcoded in sev_snp.py)
- Fix measurement prefix sha256: → sha384: (SEV-SNP uses SHA-384)
  in both the sample claim output and expected_measurement config

multi-tenant-config.md
- cmcp-gateway → cmcp-runtime

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Both tenant A and tenant B policy blocks used Action::"call_tool" instead
of the required cMCP::Action::"call_tool" namespace.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@imran-siddique imran-siddique merged commit 5cf0fa4 into main Jun 22, 2026
10 checks passed
@imran-siddique imran-siddique deleted the fix/tutorial-accuracy branch June 22, 2026 20:06
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