Skip to content

docs: lead with the install script and drop a triplicated MCP paragraph #377

Description

@YoungJinJung

Summary

Two README fixes in the installation and MCP sections.

1. Lead with the install script

The Homebrew path needs three commands and a trust decision since Homebrew 6.0.0 (#369). The install script is a single line with no trust step, so it is the lower-friction entry point for a first-time reader:

curl -sSL https://raw.githubusercontent.com/DevopsArtFactory/unic/main/install.sh | sh

Put Install Script before Homebrew under ## Installation. Both stay documented; only the order changes. This does not close #376 — that asks for one-command brew install unic, which is gated on homebrew-core notability — but it is the part that can be done today.

2. Remove a triplicated MCP paragraph

README.md repeats the "The server provides/exposes the read-only resource operations listed above ..." paragraph and its example-prompt list three times in a row, around lines 259, 264, and 269.

This is a regression from merging the #360 fills serially. Each of #364, #367, and #368 edited that sentence to name its own tool, and my conflict resolutions for #367 and #368 kept both sides instead of merging them. The same class of defect as #317.

The three copies carry different example prompts, so the fix is one paragraph plus the union of the prompts:

  • Show the AWS capabilities available through unic. (duplicated 3×)
  • List my AWS Backup vaults in ap-northeast-2. (duplicated 3×)
  • Show my deepest SQS backlogs and their dead-letter queue relationships.
  • Show failed or rollback CloudFormation stacks and their status reasons.
  • Show the recent failed executions for this STANDARD Step Functions state machine ARN.
  • Preview a unic context sync without changing config.

The surviving sentence should not name an example tool. Naming one is what made the line conflict on every fill, and the command list above it already enumerates them.

Checklist

  • Move ### Install Script above ### Homebrew
  • Collapse the three MCP paragraphs into one with the merged prompt list
  • Check no other duplicated paragraphs remain in README.md
  • Verify order-dependent wording such as "the install script above" still reads correctly

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions