Review readme and improve each tool's description #11
Conversation
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
AzemaBaptiste
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR improves documentation for each tool, upgrades dependency versions, and removes unnecessary translation files.
- Updates tool descriptions and renames functions for clarity
- Upgrades dependency versions and bumps package version in pyproject.toml
- Removes extraneous Chainlit translation files
Reviewed Changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/sifflet_mcp/server.py | Updated tool descriptions, renamed parameters/functions, and added type annotations; improved JSON serializability in downstream assets. |
| pyproject.toml | Bumped package version and upgraded dependency versions. |
| README.md | Revised documentation to reflect SIFFLET_BACKEND_URL usage. |
| .chainlit/translations/* | Removed unnecessary translation files as requested. |
Comments suppressed due to low confidence (1)
src/sifflet_mcp/server.py:113
- The parameter was renamed from 'owners' to 'owners_email' for clarity; please ensure that the list comprehension using this parameter is updated consistently in the code.
owners_email: List[str],
| # Monitor as code | ||
| @mcp.tool("get_monitor_code_by_description") | ||
| @mcp.tool( | ||
| "get_monitor_code_by_description", |
Collaborator
There was a problem hiding this comment.
I wondering whether it should be a "get" or "create". Get implies that we get something from the database but it's not the case. "create" implies that we create something in the db, not the case either.
pierrecourgeon1
approved these changes
May 13, 2025
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.
Uh oh!
There was an error while loading. Please reload this page.