addressing PR comments

Author: Aaditya Bhoota

src/aws-documentation-mcp-server/awslabs/aws_documentation_mcp_server/models.py

@@ -29,7 +29,7 @@ class SearchResult(BaseModel):
 class SearchResponse(BaseModel):
     """Complete search response including results and facets."""
 
-    searchResults: List[SearchResult]
+    search_results: List[SearchResult]
     facets: Optional[Dict[str, List[str]]] = None
     query_id: str
 

src/aws-documentation-mcp-server/awslabs/aws_documentation_mcp_server/server_aws.py

@@ -202,8 +202,8 @@ async def search_documentation(
 
     ## Result Interpretation
 
-    Each result includes:
-    - searchResults: List of documentation pages, each with:
+    Each SearchResponse includes:
+    - search_results: List of documentation pages, each with:
         - rank_order: The relevance ranking (lower is more relevant)
         - url: The documentation page URL
         - title: The page title
@@ -267,7 +267,7 @@ async def search_documentation(
             logger.error(error_msg)
             await ctx.error(error_msg)
             return SearchResponse(
-                searchResults=[SearchResult(rank_order=1, url='', title=error_msg, context=None)],
+                search_results=[SearchResult(rank_order=1, url='', title=error_msg, context=None)],
                 facets=None,
                 query_id='',
             )
@@ -277,7 +277,7 @@ async def search_documentation(
             logger.error(error_msg)
             await ctx.error(error_msg)
             return SearchResponse(
-                searchResults=[SearchResult(rank_order=1, url='', title=error_msg, context=None)],
+                search_results=[SearchResult(rank_order=1, url='', title=error_msg, context=None)],
                 facets=None,
                 query_id='',
             )
@@ -301,7 +301,7 @@ async def search_documentation(
             logger.error(error_msg)
             await ctx.error(error_msg)
             return SearchResponse(
-                searchResults=[SearchResult(rank_order=1, url='', title=error_msg, context=None)],
+                search_results=[SearchResult(rank_order=1, url='', title=error_msg, context=None)],
                 facets=None,
                 query_id='',
             )
@@ -336,11 +336,11 @@ async def search_documentation(
 
     logger.debug(f'Found {len(results)} search results for: {search_phrase}')
     logger.debug(f'Search query ID: {query_id}')
-    finalSearchResponse = SearchResponse(
-        searchResults=results, facets=facets if facets else None, query_id=query_id
+    final_search_response = SearchResponse(
+        search_results=results, facets=facets if facets else None, query_id=query_id
     )
-    add_search_result_cache_item(finalSearchResponse)
-    return finalSearchResponse
+    add_search_result_cache_item(final_search_response)
+    return final_search_response
 
 
 @mcp.tool()

src/aws-documentation-mcp-server/awslabs/aws_documentation_mcp_server/server_utils.py

@@ -135,7 +135,7 @@ def get_query_id_from_cache(url: str) -> Optional[str]:
 
     """
     for _, search_responses in enumerate(SEARCH_RESULT_CACHE):
-        for search_result in search_responses.searchResults:
+        for search_result in search_responses.search_results:
             if search_result.url == url:
                 # Sanitization of query_id just in case
                 query_id = quote(search_responses.query_id)

src/aws-documentation-mcp-server/tests/test_aws_search_live.py

@@ -44,7 +44,7 @@ async def test_search_documentation_live():
         response = await search_documentation(
             ctx, search_phrase=search_phrase, limit=5, product_types=None, guide_types=None
         )
-        results = response.searchResults
+        results = response.search_results
         # Verify the results
         assert results is not None
         assert len(results) > 0
@@ -85,7 +85,7 @@ async def test_search_documentation_empty_results():
         response = await search_documentation(
             ctx, search_phrase=search_phrase, limit=5, product_types=None, guide_types=None
         )
-        results = response.searchResults
+        results = response.search_results
 
         # We don't assert on the number of results, as it might change over time
         # Just verify that the function returns a valid response
@@ -118,12 +118,12 @@ async def test_search_documentation_limit():
         response_small = await search_documentation(
             ctx, search_phrase=search_phrase, limit=3, product_types=None, guide_types=None
         )
-        results_small = response_small.searchResults
+        results_small = response_small.search_results
         # Test with limit=10
         response_large = await search_documentation(
             ctx, search_phrase=search_phrase, limit=10, product_types=None, guide_types=None
         )
-        results_large = response_large.searchResults
+        results_large = response_large.search_results
 
         # Verify that the limits are respected
         assert len(results_small) <= 3
@@ -152,7 +152,7 @@ async def test_search_documentation_with_product_type():
         first_response = await search_documentation(
             ctx, search_phrase=search_phrase, limit=10, product_types=None, guide_types=None
         )
-        first_results = first_response.searchResults
+        first_results = first_response.search_results
         # Verify first search results
         assert first_response is not None
         assert first_results is not None
@@ -173,12 +173,13 @@ async def test_search_documentation_with_product_type():
             product_types=[first_product_type],
             guide_types=None,
         )
-        second_results = second_response.searchResults
+        second_results = second_response.search_results
 
         # Verify second search results
         assert second_response is not None
         assert second_results is not None
         assert len(second_results) > 0
+        assert first_product_type in second_response.facets['product_types']
 
 
 @pytest.mark.asyncio
@@ -196,7 +197,7 @@ async def test_search_documentation_with_guide_type():
         first_response = await search_documentation(
             ctx, search_phrase=search_phrase, limit=10, product_types=None, guide_types=None
         )
-        first_results = first_response.searchResults
+        first_results = first_response.search_results
         # Verify first search results
         assert first_response is not None
         assert first_results is not None
@@ -217,12 +218,13 @@ async def test_search_documentation_with_guide_type():
             product_types=None,
             guide_types=[first_guide_type],
         )
-        second_results = second_response.searchResults
+        second_results = second_response.search_results
 
         # Verify second search results
         assert second_response is not None
         assert second_results is not None
         assert len(second_results) > 0
+        assert first_guide_type in second_response.facets['guide_types']
 
 
 if __name__ == '__main__':

src/aws-documentation-mcp-server/tests/test_metadata_handling.py

@@ -61,7 +61,7 @@ async def test_seo_abstract_priority(self):
             response = await search_documentation(
                 ctx, search_phrase='test', limit=10, product_types=None, guide_types=None
             )
-            results = response.searchResults
+            results = response.search_results
             assert len(results) == 1
             assert results[0].context == 'SEO optimized abstract'
 
@@ -96,7 +96,7 @@ async def test_abstract_fallback(self):
             response = await search_documentation(
                 ctx, search_phrase='test', limit=10, product_types=None, guide_types=None
             )
-            results = response.searchResults
+            results = response.search_results
             assert len(results) == 1
             assert results[0].context == 'Regular abstract'
 
@@ -128,7 +128,7 @@ async def test_summary_fallback(self):
             response = await search_documentation(
                 ctx, search_phrase='test', limit=10, product_types=None, guide_types=None
             )
-            results = response.searchResults
+            results = response.search_results
             assert len(results) == 1
             assert results[0].context == 'Regular summary'
 
@@ -159,7 +159,7 @@ async def test_suggestion_body_fallback(self):
             response = await search_documentation(
                 ctx, search_phrase='test', limit=10, product_types=None, guide_types=None
             )
-            results = response.searchResults
+            results = response.search_results
             assert len(results) == 1
             assert results[0].context == 'Suggestion body text'
 
@@ -189,7 +189,7 @@ async def test_no_context_available(self):
             response = await search_documentation(
                 ctx, search_phrase='test', limit=10, product_types=None, guide_types=None
             )
-            results = response.searchResults
+            results = response.search_results
             assert len(results) == 1
             assert results[0].context is None
 
@@ -220,7 +220,7 @@ async def test_empty_metadata(self):
             response = await search_documentation(
                 ctx, search_phrase='test', limit=10, product_types=None, guide_types=None
             )
-            results = response.searchResults
+            results = response.search_results
             assert len(results) == 1
             assert results[0].context == 'Regular summary'
 
@@ -275,7 +275,7 @@ async def test_mixed_metadata_availability(self):
             response = await search_documentation(
                 ctx, search_phrase='test', limit=10, product_types=None, guide_types=None
             )
-            results = response.searchResults
+            results = response.search_results
             assert len(results) == 4
             assert results[0].context == 'SEO abstract 1'
             assert results[1].context == 'Regular abstract 2'
@@ -324,7 +324,7 @@ async def test_real_world_example_with_metadata(self):
             response = await search_documentation(
                 ctx, search_phrase='s3', limit=10, product_types=None, guide_types=None
             )
-            results = response.searchResults
+            results = response.search_results
             assert len(results) == 2
             # First result should use seo_abstract
             assert (
@@ -361,6 +361,6 @@ async def test_missing_metadata_field(self):
             response = await search_documentation(
                 ctx, search_phrase='test', limit=10, product_types=None, guide_types=None
             )
-            results = response.searchResults
+            results = response.search_results
             assert len(results) == 1
             assert results[0].context == 'Regular summary'

src/aws-documentation-mcp-server/tests/test_models.py

@@ -68,11 +68,11 @@ def test_search_response_creation(self):
         }
 
         response = SearchResponse(
-            searchResults=search_results, facets=facets, query_id='test-query-id'
+            search_results=search_results, facets=facets, query_id='test-query-id'
         )
 
-        assert len(response.searchResults) == 1
-        assert response.searchResults[0].title == 'Test 1'
+        assert len(response.search_results) == 1
+        assert response.search_results[0].title == 'Test 1'
         assert response.facets == facets
         assert response.query_id == 'test-query-id'
 
@@ -86,9 +86,9 @@ def test_search_response_without_facets(self):
             )
         ]
 
-        response = SearchResponse(searchResults=search_results, query_id='test-query-id')
+        response = SearchResponse(search_results=search_results, query_id='test-query-id')
 
-        assert len(response.searchResults) == 1
+        assert len(response.search_results) == 1
         assert response.facets is None
         assert response.query_id == 'test-query-id'
 

src/aws-documentation-mcp-server/tests/test_server_aws.py

@@ -169,7 +169,7 @@ async def test_search_documentation(self):
             response = await search_documentation(
                 ctx, search_phrase=search_phrase, limit=10, product_types=None, guide_types=None
             )
-            results = response.searchResults
+            results = response.search_results
             assert len(results) == 2
             assert results[0].rank_order == 1
             assert results[0].url == 'https://docs.aws.amazon.com/test1'
@@ -241,7 +241,7 @@ async def test_search_documentation_with_domain_modification(self):
             results = await search_documentation(
                 ctx, search_phrase=search_phrase, limit=10, product_types=None, guide_types=None
             )
-            search_results = results.searchResults
+            search_results = results.search_results
             assert len(search_results) == 2
             mock_post.assert_called_once()
 
@@ -273,7 +273,7 @@ async def test_search_documentation_http_error(self):
             response = await search_documentation(
                 ctx, search_phrase=search_phrase, limit=10, product_types=None, guide_types=None
             )
-            results = response.searchResults
+            results = response.search_results
             assert len(results) == 1
             assert results[0].rank_order == 1
             assert results[0].url == ''
@@ -295,7 +295,7 @@ async def test_search_documentation_status_error(self):
             response = await search_documentation(
                 ctx, search_phrase=search_phrase, limit=10, product_types=None, guide_types=None
             )
-            results = response.searchResults
+            results = response.search_results
 
             assert len(results) == 1
             assert results[0].rank_order == 1
@@ -319,7 +319,7 @@ async def test_search_documentation_json_error(self):
             response = await search_documentation(
                 ctx, search_phrase=search_phrase, limit=10, product_types=None, guide_types=None
             )
-            results = response.searchResults
+            results = response.search_results
 
             assert len(results) == 1
             assert results[0].rank_order == 1
@@ -343,7 +343,7 @@ async def test_search_documentation_empty_results(self):
             response = await search_documentation(
                 ctx, search_phrase=search_phrase, limit=10, product_types=None, guide_types=None
             )
-            results = response.searchResults
+            results = response.search_results
             assert len(results) == 0
             mock_post.assert_called_once()
 
@@ -373,7 +373,8 @@ async def test_search_documentation_with_filters(self):
                 product_types=['Amazon S3', 'AWS Lambda'],
                 guide_types=['User Guide', 'API Reference'],
             )
-            context_attrs = mock_post.call_args[1]['json']['contextAttributes']
+            args, kwargs = mock_post.call_args
+            context_attrs = kwargs['json']['contextAttributes']
             assert {'key': 'aws-docs-search-product', 'value': 'Amazon S3'} in context_attrs
             assert {'key': 'aws-docs-search-product', 'value': 'AWS Lambda'} in context_attrs
             assert {'key': 'aws-docs-search-guide', 'value': 'User Guide'} in context_attrs
@@ -387,14 +388,16 @@ async def test_search_documentation_with_filters(self):
             await search_documentation(
                 ctx, search_phrase='test', limit=10, product_types=['Amazon S3'], guide_types=None
             )
-            context_attrs = mock_post.call_args[1]['json']['contextAttributes']
+            args, kwargs = mock_post.call_args
+            context_attrs = kwargs['json']['contextAttributes']
             assert {'key': 'aws-docs-search-product', 'value': 'Amazon S3'} in context_attrs
 
             # Test only guide filter
             await search_documentation(
                 ctx, search_phrase='test', limit=10, product_types=None, guide_types=['User Guide']
             )
-            context_attrs = mock_post.call_args[1]['json']['contextAttributes']
+            args, kwargs = mock_post.call_args
+            context_attrs = kwargs['json']['contextAttributes']
             assert {'key': 'aws-docs-search-guide', 'value': 'User Guide'} in context_attrs