-
Notifications
You must be signed in to change notification settings - Fork 143
Tool descriptions update #109
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates the tool descriptions across several packages to provide more detailed guidance and examples on their usage. The changes aim to enhance clarity by expanding on the available parameters, return values, and usage scenarios for each tool.
- Updated descriptions for Grafana dashboards, Prometheus queries, OnCall schedules and shifts, Loki queries, incidents, datasources, dashboards, and alerting tools
- Added examples and extra details (such as supported pagination, filtering, and default behaviors) to improve user understanding
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
tools/search.go | Updated the dashboard search tool description to be more detailed |
tools/prometheus.go | Expanded Prometheus tool descriptions with specifics on query types and pagination |
tools/oncall.go | Enhanced OnCall tool descriptions to include filtering details and return summaries |
tools/loki.go | Detailed descriptions for Loki tools with default values and example outputs |
tools/incident.go | Revised incident tool descriptions to include additional metadata and context |
tools/datasources.go | Updated datasource tool descriptions with comprehensive details |
tools/dashboard.go | Improved dashboard retrieval description with expanded information |
tools/alerting.go | Refined alerting tool descriptions with examples and detailed response fields |
f659c73
to
f19b1be
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some minor suggestions but generally lgtm
tools/dashboard.go
Outdated
<<<<<<< HEAD | ||
UpdateDashboard.Register(mcp) | ||
======= | ||
>>>>>>> 5a539dd (improve search and dashboard descriptions) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Conflict here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
whaaaat? I resolved this.. no idea how it got committed like that :(
Co-authored-by: Ben Sully <ben.sully@grafana.com>
Co-authored-by: Ben Sully <ben.sully@grafana.com>
c3f7323
to
edd8d59
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Update tool descriptions, add more descriprive text and add a couple of examples.
The provided e2e tests are not enough to prove that those are improved descriptions but for now I followed guidelines from anthropic.
Closes 48