fix: Return -1 for missing metadata in Jira Cloud search (#333) #360
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
The Jira Cloud enhanced search API (/rest/api/3/search/jql) used by atlassian-python-api's enhanced_jql method does not return the total, startAt, or maxResults fields, instead relying on nextPageToken for pagination. Previously, JiraSearchResult's @model_validator incorrectly overwrote the default 0 values for these fields with the count of issues returned in the current page (len(self.issues)), leading to the bug reported in #333 where total often equaled the requested limit. This commit: 1. Removes the problematic @model_validator logic that modified total and max_results 2. Updates JiraSearchResult.from_api_response to return -1 for total, start_at, and max_results when these values are missing or invalid in the API response The underlying limitation that the true total is not available via the current library method remains and is documented as a known issue.
2 tasks
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.
Description
Refs #333
This PR addresses an issue where the
jira_searchtool incorrectly reportedtotalandmax_resultsvalues equal to the requestedlimitin Jira Cloud environments. The root cause was identified as:enhanced_jqlAPI endpoint used byatlassian-python-apidoes not includetotal,startAt,maxResultsfields in responsesJiraSearchResultmodel validator incorrectly overwrote these missing values with the current page's issue counttotalto get the correct count even if it's a cloud in a separate API callNote: While we could implement direct REST API calls to get this metadata, we're maintaining our dependency on
atlassian-python-apias it provides consistent JQL support across Server/DC environments and underlies most of our other Jira integrations. The metadata limitation will be handled by returning-1for unavailable values until direct REST API implementation becomes a critical requirement.Changes
@model_validatorlogic inJiraSearchResultthat overwrote metadata valuesJiraSearchResult.from_api_responseto return-1for missing/invalid metadata fields-1metadata values in Cloud responsesTesting
test_from_api_response_missing_metadatatoTestJiraSearchResulttest_call_tool_successin server tests for new metadata behaviormcp-inspectorthatjira_searchreturns-1for metadata in Cloud environmentChecklist
-1values as known limitation in Cloud environments and rationale for maintaining current library dependency