list_projects
Retrieve and filter ServiceNow projects by state, assignment group, or timeframe to manage project visibility and tracking.
Instructions
List projects from ServiceNow
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of records to return | |
| offset | No | Offset to start from | |
| state | No | Filter by state | |
| assignment_group | No | Filter by assignment group | |
| timeframe | No | Filter by timeframe (upcoming, in-progress, completed) | |
| query | No | Additional query string |
Implementation Reference
- The handler function that implements the list_projects tool. It validates parameters using ListProjectsParams, builds a query for filtering projects, makes a GET request to the ServiceNow pm_project table API, and returns the list of projects.def list_projects( config: ServerConfig, # Changed from auth_manager auth_manager: AuthManager, # Changed from server_config params: Dict[str, Any], ) -> Dict[str, Any]: """ List projects from ServiceNow. Args: config: The server configuration. auth_manager: The authentication manager. params: The parameters for listing projects. Returns: A list of projects. """ # Unwrap and validate parameters result = _unwrap_and_validate_params( params, ListProjectsParams ) if not result["success"]: return result validated_params = result["params"] # Build the query query_parts = [] if validated_params.state: query_parts.append(f"state={validated_params.state}") if validated_params.assignment_group: query_parts.append(f"assignment_group={validated_params.assignment_group}") # Handle timeframe filtering if validated_params.timeframe: now = datetime.now().strftime("%Y-%m-%d %H:%M:%S") if validated_params.timeframe == "upcoming": query_parts.append(f"start_date>{now}") elif validated_params.timeframe == "in-progress": query_parts.append(f"start_date<{now}^end_date>{now}") elif validated_params.timeframe == "completed": query_parts.append(f"end_date<{now}") # Add any additional query string if validated_params.query: query_parts.append(validated_params.query) # Combine query parts query = "^".join(query_parts) if query_parts else "" # Get the instance URL instance_url = _get_instance_url(auth_manager, config) if not instance_url: return { "success": False, "message": "Cannot find instance_url in either server_config or auth_manager", } # Get the headers headers = _get_headers(auth_manager, config) if not headers: return { "success": False, "message": "Cannot find get_headers method in either auth_manager or server_config", } # Make the API request url = f"{instance_url}/api/now/table/pm_project" params = { "sysparm_limit": validated_params.limit, "sysparm_offset": validated_params.offset, "sysparm_query": query, "sysparm_display_value": "true", } try: response = requests.get(url, headers=headers, params=params) response.raise_for_status() result = response.json() # Handle the case where result["result"] is a list projects = result.get("result", []) count = len(projects) return { "success": True, "projects": projects, "count": count, "total": count, # Use count as total if total is not provided } except requests.exceptions.RequestException as e: logger.error(f"Error listing projects: {e}") return { "success": False, "message": f"Error listing projects: {str(e)}", }
- Pydantic model defining the input parameters for the list_projects tool, including pagination, filters, and custom query options.class ListProjectsParams(BaseModel): """Parameters for listing projects.""" limit: Optional[int] = Field(10, description="Maximum number of records to return") offset: Optional[int] = Field(0, description="Offset to start from") state: Optional[str] = Field(None, description="Filter by state") assignment_group: Optional[str] = Field(None, description="Filter by assignment group") timeframe: Optional[str] = Field(None, description="Filter by timeframe (upcoming, in-progress, completed)") query: Optional[str] = Field(None, description="Additional query string")
- src/servicenow_mcp/utils/tool_utils.py:938-944 (registration)Registration of the list_projects tool in the central tool definitions dictionary used by the MCP server, mapping name to handler, schema, description, etc."list_projects": ( list_projects_tool, ListProjectsParams, str, # Expects JSON string "List projects from ServiceNow", "json", # Tool returns list/dict ),
- src/servicenow_mcp/tools/__init__.py:110-114 (registration)Import of the list_projects function into the tools package __init__.py for exposure.from servicenow_mcp.tools.project_tools import ( create_project, update_project, list_projects, )
- src/servicenow_mcp/tools/__init__.py:222-222 (registration)Inclusion of list_projects in the __all__ list for public API exposure."list_projects",