Skip to content

Rewrite README: quickstart, security model, full CLI reference - #40

Merged
haasonsaas merged 1 commit into
mainfrom
docs/readme-overhaul
Aug 4, 2026
Merged

Rewrite README: quickstart, security model, full CLI reference#40
haasonsaas merged 1 commit into
mainfrom
docs/readme-overhaul

Conversation

@haasonsaas

Copy link
Copy Markdown
Collaborator

Documentation only. Rewrites README.md to match the current CLI surface after #39.

  • Quickstart: npx -y github:evalops/mcp-openapi, claude mcp add, Claude Desktop JSON.
  • Explicit warning that the mcp-openapi package on npm is an unrelated third-party project.
  • New "Security model" section: default 127.0.0.1 binding, Origin validation, MCP_OPENAPI_HTTP_AUTH_TOKEN, outbound allowlists, policy webhook semantics (fail-closed, 30 s cache), log redaction, size/concurrency caps.
  • Complete flag table. Previously undocumented: --descriptions, --auth-scope, --policy-webhook, --tool-name-separator, --host, --allow-origins, and the {service} template placeholder.
  • Operation→tool mapping (annotations, input grouping, x-mcp-hidden/x-mcp-description), pagination contract, auth env table, metrics list, scaffolding, dev commands.

🤖 Generated with Claude Code

https://claude.ai/code/session_01LqBsGC7xLvihtBxhCdWKz5

- npx/Claude Code/Claude Desktop quickstart snippets
- Warning that the npm package named mcp-openapi is an unrelated project
- Security model section: default 127.0.0.1 binding, Origin validation,
  MCP_OPENAPI_HTTP_AUTH_TOKEN, outbound allowlists, policy webhook,
  log redaction, size/concurrency caps
- Complete flag table including previously undocumented flags
  (--descriptions, --auth-scope, --policy-webhook, --tool-name-separator,
  --host, --allow-origins, {service} placeholder)
- Operation-to-tool mapping, pagination, auth env var table, metrics list

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LqBsGC7xLvihtBxhCdWKz5
@haasonsaas
haasonsaas merged commit af86a93 into main Aug 4, 2026
4 checks passed
@haasonsaas
haasonsaas deleted the docs/readme-overhaul branch August 4, 2026 02:51
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