Skip to content

docs: add keyring integration documentation#314

Merged
Dumbris merged 1 commit intomainfrom
docs/keyring-integration
Feb 28, 2026
Merged

docs: add keyring integration documentation#314
Dumbris merged 1 commit intomainfrom
docs/keyring-integration

Conversation

@Dumbris
Copy link
Contributor

@Dumbris Dumbris commented Feb 28, 2026

Summary

  • Added comprehensive documentation for MCPProxy's keyring/secrets management feature at docs/features/keyring-integration.md

What's covered

  • Secret reference syntax: ${keyring:name} and ${env:NAME} with config examples
  • CLI commands: All 5 subcommands (secrets set/get/del/list/migrate) with flags, examples, and output
  • Web UI: Secrets management page — filtering, add/update/delete modals, migration analysis
  • REST API: All 5 endpoints under /api/v1/secrets/ with request/response examples
  • How it works: Resolution flow, automatic server restart on secret change, log sanitization
  • Platform support: macOS Keychain, Linux secret-service, Windows Credential Manager
  • Troubleshooting: Platform-specific issues and solutions
  • Security considerations: 6 key properties

Accuracy verification

All documented features were cross-referenced against source code:

  • CLI: cmd/mcpproxy/secrets_cmd.go
  • API: internal/httpapi/server.go
  • Parser: internal/secret/parser.go
  • Resolution: internal/upstream/core/client.go
  • Auto-restart: internal/runtime/runtime.go

Test plan

  • All CLI commands verified against Cobra definitions
  • All API routes verified against router registration
  • Secret resolution scope verified (env, args, headers — not url or oauth fields)
  • Auto-restart scope verified (env and args only)
  • Masking formats verified (CLI: 4 asterisks, logs: 3 asterisks)

🤖 Generated with Claude Code

Add docs/features/keyring-integration.md covering:
- Secret reference syntax (${keyring:name}, ${env:NAME})
- CLI commands: secrets set/get/del/list/migrate with all flags
- Web UI: secrets management page
- REST API: 5 endpoints under /api/v1/secrets/
- Platform support (macOS Keychain, Linux, Windows)
- Auto-restart, log sanitization, troubleshooting
- Security considerations

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@cloudflare-workers-and-pages
Copy link

Deploying mcpproxy-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 3287ebd
Status: ✅  Deploy successful!
Preview URL: https://e5e2f150.mcpproxy-docs.pages.dev
Branch Preview URL: https://docs-keyring-integration.mcpproxy-docs.pages.dev

View logs

@github-actions
Copy link

📦 Build Artifacts

Workflow Run: View Run
Branch: docs/keyring-integration

Available Artifacts

  • archive-darwin-amd64 (23 MB)
  • archive-darwin-arm64 (21 MB)
  • archive-linux-amd64 (12 MB)
  • archive-linux-arm64 (11 MB)
  • archive-windows-amd64 (23 MB)
  • archive-windows-arm64 (21 MB)
  • frontend-dist-pr (0 MB)
  • installer-dmg-darwin-amd64 (26 MB)
  • installer-dmg-darwin-arm64 (23 MB)

How to Download

Option 1: GitHub Web UI (easiest)

  1. Go to the workflow run page linked above
  2. Scroll to the bottom "Artifacts" section
  3. Click on the artifact you want to download

Option 2: GitHub CLI

gh run download 22525672554 --repo smart-mcp-proxy/mcpproxy-go

Note: Artifacts expire in 14 days.

@Dumbris Dumbris merged commit 591f861 into main Feb 28, 2026
24 checks passed
@Dumbris Dumbris deleted the docs/keyring-integration branch February 28, 2026 18:17
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.

2 participants