docs(iam-mcp-server): fix stale --readonly flag references - #4349
Open
AmirF194 wants to merge 1 commit into
Open
docs(iam-mcp-server): fix stale --readonly flag references#4349AmirF194 wants to merge 1 commit into
AmirF194 wants to merge 1 commit into
Conversation
PR awslabs#2861 replaced --readonly with --allow-write and made read-only the default, but the README's Read-Only Mode section was never updated. Following it literally makes argparse reject the flag with exit 2, so the server never starts. Fixes awslabs#3531
Author
|
Gentle bump, no rush. Let me know if the PR body's contributor statement needs anything else, that was the one check that needed a fix on our side and it's already addressed. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The IAM MCP server's README still documents the
--readonlyflag in four places, but PR #2861 (2026-04-09) replaced it with--allow-writeand made read-only the default. Following the README literally makesargparsereject the server's own CLI withunrecognized arguments: --readonly(exit 2), so the server never starts.Fix
Updated the "Read-Only Mode" section to describe the current default: no flag is needed for read-only, and
--allow-writeopts into write mode. Updated the four--readonlyreferences (CLI examples, Kiro config, other-clients note) accordingly.Verification
Confirmed on current HEAD, in a clean
python:3.12-slimcontainer with the package installed viapip install -e .:python -m awslabs.iam_mcp_server.server --readonly→error: unrecognized arguments: --readonly, exit 2.python -m awslabs.iam_mcp_server.server --allow-write→ starts and logs "Server started in WRITE mode".This is a documentation-only change; no server code was touched, so no test changes are needed.
Fixes #3531
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.