Skip to content

Commit 838cd23

Browse files
Merge pull request #48 from netboxlabs/feat/encourage-fields
fix: added stronger wording to pagination and fields
2 parents dd7c4d2 + b1a7272 commit 838cd23

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

server.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -339,6 +339,8 @@ def netbox_get_objects(
339339
- results: Array of objects for this page
340340
ALWAYS REFER TO THIS FIELD FOR THE OBJECTS ON THIS PAGE
341341
342+
ENSURE YOU ARE AWARE THE RESULTS ARE PAGINATED BEFORE PROVIDING RESPONSE TO THE USER.
343+
342344
Valid object_type values:
343345
344346
DCIM (Device and Infrastructure):
@@ -463,7 +465,10 @@ def netbox_get_objects(
463465

464466
@mcp.tool
465467
def netbox_get_object_by_id(
466-
object_type: str, object_id: int, fields: list[str] | None = None, brief: bool = False
468+
object_type: str,
469+
object_id: int,
470+
fields: list[str] | None = None,
471+
brief: bool = False,
467472
):
468473
"""
469474
Get detailed information about a specific NetBox object by its ID.
@@ -587,7 +592,7 @@ def netbox_search_objects(
587592
Default: ['devices', 'sites', 'ip-addresses', 'interfaces',
588593
'racks', 'vlans', 'circuits', 'virtual-machines']
589594
Examples: ['devices', 'ip-addresses', 'sites']
590-
fields: Optional list of specific fields to return (reduces response size)
595+
fields: Optional list of specific fields to return (reduces response size) IT IS STRONGLY RECOMMENDED TO USE THIS PARAMETER TO MINIMIZE TOKEN USAGE.
591596
- None or [] = returns all fields (no filtering)
592597
- ['id', 'name'] = returns only specified fields
593598
Examples: ['id', 'name', 'status'], ['address', 'dns_name']

0 commit comments

Comments
 (0)