Skip to content

Conversation

ioanarm
Copy link
Contributor

@ioanarm ioanarm commented Apr 25, 2025

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

@sd2k sd2k requested a review from Copilot April 25, 2025 14:52
Copy link

@Copilot Copilot AI left a 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

@ioanarm ioanarm marked this pull request as ready for review April 28, 2025 07:40
@ioanarm ioanarm requested a review from a team as a code owner April 28, 2025 07:40
@ioanarm ioanarm force-pushed the generic-improvements branch from f659c73 to f19b1be Compare April 28, 2025 07:42
Copy link
Collaborator

@sd2k sd2k left a 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

Comment on lines 67 to 70
<<<<<<< HEAD
UpdateDashboard.Register(mcp)
=======
>>>>>>> 5a539dd (improve search and dashboard descriptions)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Conflict here

Copy link
Contributor Author

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 :(

ioanarm and others added 4 commits April 28, 2025 15:31
Co-authored-by: Ben Sully <ben.sully@grafana.com>
Co-authored-by: Ben Sully <ben.sully@grafana.com>
@ioanarm ioanarm force-pushed the generic-improvements branch from c3f7323 to edd8d59 Compare April 29, 2025 07:55
Copy link
Contributor

@gitdoluquita gitdoluquita left a comment

Choose a reason for hiding this comment

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

LGTM!

@ioanarm ioanarm merged commit b469d39 into main Apr 29, 2025
5 checks passed
@ioanarm ioanarm deleted the generic-improvements branch April 29, 2025 15:28
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.

Improve tool descriptions
3 participants