Skip to content

Update documentation for repository renaming - #20

Open
Akshat0694 wants to merge 3 commits into
mainfrom
docs/revamp
Open

Akshat0694 wants to merge 3 commits into
mainfrom
docs/revamp

Conversation

@Akshat0694

Copy link
Copy Markdown
Member

Clarify the recent renaming of the repository from StackGuardian/add-sg-mcp to StackGuardian/stackguardian-mcp in the documentation. Update all relevant references to ensure consistency throughout the documentation.

@arunim2405 arunim2405 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P3] Use the maintained npm package in the agent-list command — README.md:95

The Supported agents command resolves the deprecated add-sg-mcp npm package instead of @stackguardian/mcp-wizard; the inline finding gives the replacement. No blocking findings.

Overall assessment: Approve with one low-priority documentation correction. Reviewed the complete four-file diff at 1ae8e56d8f0aefd9e49dc9135d7e41361ff886d8, using merge base 5735fa7f5038e96631e100ab74d2b60932bb79a7. The repository/package distinctions in the release guidance are now correct.

Validation: bun run typecheck, bun run build, all 22/22 test files, git diff --check, and 25 local documentation links/anchors passed in an isolated archive. Cross-checked the README against the CLI and bundled skills, npm package metadata, and the v1.0.6/v1.1.0 build-provenance repository names. GitHub checks are green. The working checkout was left unchanged.

Validation limit: no live cloud deployments or hosted MCP mutation flows were exercised.

Comment thread README.md Outdated
## What your agent can do
## Supported agents

**Claude Code, Cursor, Codex, VS Code (Copilot), Gemini CLI, OpenCode, Windsurf**, plus GitHub Copilot CLI, Kiro CLI, Zed, Cline, Goose, Grok Build, Kilo Code, Kimi Code, Antigravity, Pi, Mastra Code and MCPorter. Run `npx add-sg-mcp list-agents` for the current list and each agent's config file.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P3] Use the maintained npm package in the agent-list command

This newly added command uses npx add-sg-mcp list-agents, which resolves the deprecated npm package that stops at 1.1.0, rather than the maintained @stackguardian/mcp-wizard package (currently 1.2.1). The command still runs, but downloads the discontinued package and emits its deprecation warning, so it is the wrong source for the promised current agent list. Please use npx @stackguardian/mcp-wizard list-agents; add-sg-mcp remains correct for the standalone executable.

This branch has not been deployed

No deployments
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