Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the .gitignore file to exclude .DS_Store and performs a comprehensive rewrite of the UPGRADING.md guide to reflect changes in version 1.0.0, including repository renaming, endpoint deprecations, and configuration schema updates. The review feedback identifies several technical inaccuracies in the documentation that need correction: restoring the link to the MCP tool naming specification, clarifying that certain CLI flags are currently deprecated rather than fully removed, and ensuring the configuration field name matches the implementation (authServices instead of authService).
|
|
||
| Invalid names will fail MCP initialization. | ||
|
|
||
| Reference: MCP specification for tool naming. |
There was a problem hiding this comment.
The link to the MCP specification for tool naming was removed. Restoring it (or updating it to the official documentation) provides valuable context for users regarding the strict naming requirements, specifically that tool names must be in snake_case.
| Reference: MCP specification for tool naming. | |
| Reference: [MCP specification for tool naming](https://modelcontextprotocol.io/specification/basic/tools#name-requirements). |
References
- Tool names must be in snake_case.
|
|
||
| ### 4. CLI Flag Changes | ||
|
|
||
| Removed: |
There was a problem hiding this comment.
These flags are currently marked as deprecated in the code (cmd/internal/flags.go), not removed. They still function but emit a warning. Describing them as 'Deprecated' is more accurate and prevents users from thinking their existing automation will break immediately.
| Removed: | |
| Deprecated (to be removed in a future release): |
|
|
||
| ### 6. Configuration Field Rename | ||
|
|
||
| * `authSources` → `authService` |
There was a problem hiding this comment.
The nested configuration format uses the key authServices (plural), as seen in cmd/internal/config.go and the Config struct. The migration logic also specifically looks for authServices. This should be updated to match the code and avoid confusion for users migrating from the nested format.
| * `authSources` → `authService` | |
| * authService → authServices |
Description
PR Checklist
CONTRIBUTING.md
bug/issue
before writing your code! That way we can discuss the change, evaluate
designs, and agree on the general idea
!if this involve a breaking change🛠️ Fixes #<issue_number_goes_here>