Merge pull request #37 from inventree/default-pagination

Increase default pagination limit

Author: SchrodingersGat

inventree_mcp/test_mcp.py

@@ -2308,3 +2308,34 @@ def test_none_filters_is_safe(self):
         params = build_query_params({"a": 1}, None, limit=5, offset=0)
 
         self.assertEqual(params, {"a": 1, "limit": 5, "offset": 0})
+
+
+class ListToolDefaultLimitTest(InvenTreeTestCase):
+    """Every list_* tool's own `limit` default must match DEFAULT_LIMIT, not just
+    clamp_limit()'s fallback for the limit<=0 edge case.
+
+    Each tools/*.py list_* function hardcodes its own `limit: int = ...`
+    default in its signature - an agent that omits `limit` entirely never
+    reaches clamp_limit()'s own DEFAULT_LIMIT fallback, it gets whatever
+    that per-tool default is. ClampLimitTest only covers the shared
+    fallback; this guards against one file's signature drifting back to the
+    old default (25) while _common.DEFAULT_LIMIT and the rest stay at 100 -
+    checked via each tool's registered input schema (what an MCP client
+    actually sees), not by re-reading the source.
+    """
+
+    async def test_every_list_tool_defaults_limit_to_100(self):
+        tools = await mcp.list_tools()
+        list_tools = [tool for tool in tools if tool.name.startswith("list_")]
+
+        # Sanity check the filter above actually caught something, so this
+        # test can't silently pass by iterating over an empty list.
+        self.assertGreater(len(list_tools), 20)
+
+        wrong_defaults = {
+            tool.name: tool.input_schema["properties"]["limit"].get("default")
+            for tool in list_tools
+            if tool.input_schema["properties"]["limit"].get("default") != DEFAULT_LIMIT
+        }
+
+        self.assertEqual(wrong_defaults, {})

inventree_mcp/tools/_common.py

@@ -4,7 +4,7 @@
 
 from typing import Any
 
-DEFAULT_LIMIT = 25
+DEFAULT_LIMIT = 100
 MAX_LIMIT = 100
 
 
@@ -13,7 +13,11 @@ def clamp_limit(limit: int) -> int:
 
     Prevents a single tool call from dumping an unbounded number of records
     (or being handed a negative/zero value which some list views treat as
-    "no limit").
+    "no limit"). DEFAULT_LIMIT == MAX_LIMIT deliberately - every list_* tool's
+    own `limit` parameter already defaults to DEFAULT_LIMIT (so an agent
+    that omits it gets a full page, minimizing tool calls for a large
+    result set), and this is the fallback for the one case that bypasses
+    that default: a caller passing limit=0 or a negative number explicitly.
     """
     if limit <= 0:
         return DEFAULT_LIMIT

inventree_mcp/tools/attachments.py

@@ -25,7 +25,7 @@ async def list_attachments(
     is_image: bool | None = None,
     ordering: str | None = None,
     filters: dict[str, Any] | None = None,
-    limit: int = 25,
+    limit: int = 100,
     offset: int = 0,
 ) -> dict:
     """List attachments (uploaded files or external links) linked to InvenTree records.
@@ -66,7 +66,9 @@ async def list_attachments(
         filters: additional filter parameters beyond the named arguments
             above - call describe_filters("attachment") to see what's
             available, e.g. filters={"upload_user": <id>}.
-        limit: maximum number of results to return (capped at 100).
+        limit: maximum number of results to return - defaults to 100 (the
+            maximum) to minimize round trips for large result sets; pass a
+            smaller value to page through results in smaller batches.
         offset: pagination offset.
     """
     base: dict[str, Any] = {}

inventree_mcp/tools/bom.py

@@ -36,7 +36,7 @@ async def list_bom_items(
     category: int | None = None,
     ordering: str | None = None,
     filters: dict[str, Any] | None = None,
-    limit: int = 25,
+    limit: int = 100,
     offset: int = 0,
 ) -> dict:
     """List BOM (Bill of Materials) items - the components required to build an assembly.
@@ -79,7 +79,9 @@ async def list_bom_items(
             above - call describe_filters("bom_item") to see what's
             available, e.g. filters={"validated": false} for lines whose
             checksum hasn't been confirmed, or filters={"available_stock": true}.
-        limit: maximum number of results to return (capped at 100).
+        limit: maximum number of results to return - defaults to 100 (the
+            maximum) to minimize round trips for large result sets; pass a
+            smaller value to page through results in smaller batches.
         offset: pagination offset.
     """
     base: dict[str, Any] = {}
@@ -131,7 +133,7 @@ async def list_bom_substitutes(
     part: int | None = None,
     ordering: str | None = None,
     filters: dict[str, Any] | None = None,
-    limit: int = 25,
+    limit: int = 100,
     offset: int = 0,
 ) -> dict:
     """List BOM item substitutes - alternative parts permitted in place of a BOM line's sub_part.
@@ -157,7 +159,9 @@ async def list_bom_substitutes(
         filters: additional filter parameters beyond the named arguments
             above - call describe_filters("bom_substitute") to see what's
             available.
-        limit: maximum number of results to return (capped at 100).
+        limit: maximum number of results to return - defaults to 100 (the
+            maximum) to minimize round trips for large result sets; pass a
+            smaller value to page through results in smaller batches.
         offset: pagination offset.
     """
     base: dict[str, Any] = {}

inventree_mcp/tools/build_orders.py

@@ -17,7 +17,7 @@ async def list_build_orders(
     outstanding: bool | None = None,
     ordering: str | None = None,
     filters: dict[str, Any] | None = None,
-    limit: int = 25,
+    limit: int = 100,
     offset: int = 0,
 ) -> dict:
     """List build orders (manufacturing orders).
@@ -46,7 +46,9 @@ async def list_build_orders(
         filters: additional filter parameters beyond the named arguments
             above - call describe_filters("build_order") to see what's
             available, e.g. filters={"overdue": true}.
-        limit: maximum number of results to return (capped at 100).
+        limit: maximum number of results to return - defaults to 100 (the
+            maximum) to minimize round trips for large result sets; pass a
+            smaller value to page through results in smaller batches.
         offset: pagination offset.
     """
     base: dict[str, Any] = {}
@@ -104,7 +106,7 @@ async def list_build_lines(
     build: int | None = None,
     ordering: str | None = None,
     filters: dict[str, Any] | None = None,
-    limit: int = 25,
+    limit: int = 100,
     offset: int = 0,
 ) -> dict:
     """List build order line items - the components required to complete a build order.
@@ -132,7 +134,9 @@ async def list_build_lines(
             available, e.g. filters={"allocated": false} for lines still
             needing stock, or filters={"consumable": false} to exclude
             consumable (non-tracked) components.
-        limit: maximum number of results to return (capped at 100).
+        limit: maximum number of results to return - defaults to 100 (the
+            maximum) to minimize round trips for large result sets; pass a
+            smaller value to page through results in smaller batches.
         offset: pagination offset.
     """
     base: dict[str, Any] = {}
@@ -183,7 +187,7 @@ async def list_build_items(
     part: int | None = None,
     ordering: str | None = None,
     filters: dict[str, Any] | None = None,
-    limit: int = 25,
+    limit: int = 100,
     offset: int = 0,
 ) -> dict:
     """List build order allocations - stock items reserved against build order lines.
@@ -211,7 +215,9 @@ async def list_build_items(
             above - call describe_filters("build_item") to see what's
             available, e.g. filters={"output": null} for allocations not
             yet installed into a specific build output.
-        limit: maximum number of results to return (capped at 100).
+        limit: maximum number of results to return - defaults to 100 (the
+            maximum) to minimize round trips for large result sets; pass a
+            smaller value to page through results in smaller batches.
         offset: pagination offset.
     """
     base: dict[str, Any] = {}

inventree_mcp/tools/categories.py

@@ -16,7 +16,7 @@ async def list_categories(
     parent: int | None = None,
     ordering: str | None = None,
     filters: dict[str, Any] | None = None,
-    limit: int = 25,
+    limit: int = 100,
     offset: int = 0,
 ) -> dict:
     """List part categories.
@@ -41,7 +41,9 @@ async def list_categories(
             than rejected.
         filters: additional filter parameters beyond the named arguments
             above - call describe_filters("category") to see what's available.
-        limit: maximum number of results to return (capped at 100).
+        limit: maximum number of results to return - defaults to 100 (the
+            maximum) to minimize round trips for large result sets; pass a
+            smaller value to page through results in smaller batches.
         offset: pagination offset.
     """
     base: dict[str, Any] = {}

inventree_mcp/tools/companies.py

@@ -19,7 +19,7 @@ async def list_companies(
     active: bool | None = None,
     ordering: str | None = None,
     filters: dict[str, Any] | None = None,
-    limit: int = 25,
+    limit: int = 100,
     offset: int = 0,
 ) -> dict:
     """List companies (suppliers, customers, and/or manufacturers).
@@ -47,7 +47,9 @@ async def list_companies(
         filters: additional filter parameters beyond the named arguments
             above - call describe_filters("company") to see what's
             available.
-        limit: maximum number of results to return (capped at 100).
+        limit: maximum number of results to return - defaults to 100 (the
+            maximum) to minimize round trips for large result sets; pass a
+            smaller value to page through results in smaller batches.
         offset: pagination offset.
     """
     base: dict[str, Any] = {}
@@ -106,7 +108,7 @@ async def list_contacts(
     company: int | None = None,
     ordering: str | None = None,
     filters: dict[str, Any] | None = None,
-    limit: int = 25,
+    limit: int = 100,
     offset: int = 0,
 ) -> dict:
     """List contacts (people) at companies.
@@ -125,7 +127,9 @@ async def list_contacts(
         filters: additional filter parameters beyond the named arguments
             above - call describe_filters("contact") to see what's
             available.
-        limit: maximum number of results to return (capped at 100).
+        limit: maximum number of results to return - defaults to 100 (the
+            maximum) to minimize round trips for large result sets; pass a
+            smaller value to page through results in smaller batches.
         offset: pagination offset.
     """
     base: dict[str, Any] = {}
@@ -175,7 +179,7 @@ async def list_addresses(
     company: int | None = None,
     ordering: str | None = None,
     filters: dict[str, Any] | None = None,
-    limit: int = 25,
+    limit: int = 100,
     offset: int = 0,
 ) -> dict:
     """List company addresses.
@@ -194,7 +198,9 @@ async def list_addresses(
         filters: additional filter parameters beyond the named arguments
             above - call describe_filters("address") to see what's
             available.
-        limit: maximum number of results to return (capped at 100).
+        limit: maximum number of results to return - defaults to 100 (the
+            maximum) to minimize round trips for large result sets; pass a
+            smaller value to page through results in smaller batches.
         offset: pagination offset.
     """
     base: dict[str, Any] = {}

inventree_mcp/tools/locations.py

@@ -16,7 +16,7 @@ async def list_locations(
     parent: int | None = None,
     ordering: str | None = None,
     filters: dict[str, Any] | None = None,
-    limit: int = 25,
+    limit: int = 100,
     offset: int = 0,
 ) -> dict:
     """List stock locations.
@@ -41,7 +41,9 @@ async def list_locations(
             than rejected.
         filters: additional filter parameters beyond the named arguments
             above - call describe_filters("location") to see what's available.
-        limit: maximum number of results to return (capped at 100).
+        limit: maximum number of results to return - defaults to 100 (the
+            maximum) to minimize round trips for large result sets; pass a
+            smaller value to page through results in smaller batches.
         offset: pagination offset.
     """
     base: dict[str, Any] = {}

inventree_mcp/tools/parameters.py

@@ -28,7 +28,7 @@ async def list_parameters(
     template: int | None = None,
     ordering: str | None = None,
     filters: dict[str, Any] | None = None,
-    limit: int = 25,
+    limit: int = 100,
     offset: int = 0,
 ) -> dict:
     """List parameters (named attribute values) recorded against InvenTree records.
@@ -72,7 +72,9 @@ async def list_parameters(
         filters: additional filter parameters beyond the named arguments
             above - call describe_filters("parameter") to see what's
             available.
-        limit: maximum number of results to return (capped at 100).
+        limit: maximum number of results to return - defaults to 100 (the
+            maximum) to minimize round trips for large result sets; pass a
+            smaller value to page through results in smaller batches.
         offset: pagination offset.
     """
     base: dict[str, Any] = {}
@@ -128,7 +130,7 @@ async def list_parameter_templates(
     search: str | None = None,
     ordering: str | None = None,
     filters: dict[str, Any] | None = None,
-    limit: int = 25,
+    limit: int = 100,
     offset: int = 0,
 ) -> dict:
     """List parameter templates - the named attribute definitions parameters reference.
@@ -154,7 +156,9 @@ async def list_parameter_templates(
             above - call describe_filters("parameter_template") to see
             what's available, e.g. filters={"units": "V"} or
             filters={"has_choices": true}.
-        limit: maximum number of results to return (capped at 100).
+        limit: maximum number of results to return - defaults to 100 (the
+            maximum) to minimize round trips for large result sets; pass a
+            smaller value to page through results in smaller batches.
         offset: pagination offset.
     """
     base: dict[str, Any] = {}

inventree_mcp/tools/parts.py

@@ -22,7 +22,7 @@ async def list_parts(
     active: bool | None = None,
     ordering: str | None = None,
     filters: dict[str, Any] | None = None,
-    limit: int = 25,
+    limit: int = 100,
     offset: int = 0,
 ) -> dict:
     """List parts in the InvenTree database.
@@ -46,7 +46,9 @@ async def list_parts(
         filters: additional filter parameters beyond the named arguments
             above - call describe_filters("part") to see what's available,
             e.g. filters={"is_variant": true}.
-        limit: maximum number of results to return (capped at 100).
+        limit: maximum number of results to return - defaults to 100 (the
+            maximum) to minimize round trips for large result sets; pass a
+            smaller value to page through results in smaller batches.
         offset: pagination offset.
     """
     base: dict[str, Any] = {}