search_bugs_by_keyword
Search Cisco bug database using keywords for symptoms, error messages, or general terms to identify relevant technical issues and solutions.
Instructions
Search for bugs using keywords in descriptions and headlines. Use this when searching by general terms, symptoms, or when product-specific tools are not applicable. IMPORTANT: severity parameter returns ONLY that specific level. For "severity 3 or higher" searches, use multi_severity_search tool instead. NOTE: Do NOT use product IDs (like ISR4431/K9) as keywords - use search_bugs_by_product_id instead.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| keyword | Yes | Keywords to search for (general terms, symptoms, error messages - NOT product IDs) | |
| page_index | No | Page number (10 results per page) | |
| status | No | Bug status filter. IMPORTANT: Only ONE status allowed per search. Values: O=Open, F=Fixed, T=Terminated. Do NOT use comma-separated values like "O,F". | |
| severity | No | Bug severity filter. Returns bugs with ONLY the specified severity level. Values: 1=Severity 1 (highest), 2=Severity 2, 3=Severity 3, 4=Severity 4, 5=Severity 5, 6=Severity 6 (lowest). For "severity 3 or higher" bugs, use multi_severity_search tool which handles multiple separate API calls. | |
| modified_date | No | Last modified date filter. Values: 1=Last Week, 2=Last 30 Days, 3=Last 6 Months, 4=Last Year, 5=All. Default: 5 (All) | 5 |
| sort_by | No | Sort order for results. Default: modified_date (recent first) |
Implementation Reference
- src/apis/bug-api.ts:152-190 (schema)Defines the input schema, title, description, and parameters for the search_bugs_by_keyword tool.name: 'search_bugs_by_keyword', title: 'Search Bugs by Keyword', description: 'Search for bugs using keywords in descriptions and headlines. Use this when searching by general terms, symptoms, or when product-specific tools are not applicable. IMPORTANT: severity parameter returns ONLY that specific level. For "severity 3 or higher" searches, use multi_severity_search tool instead. NOTE: Do NOT use product IDs (like ISR4431/K9) as keywords - use search_bugs_by_product_id instead.', inputSchema: { type: 'object', properties: { keyword: { type: 'string', description: 'Keywords to search for (general terms, symptoms, error messages - NOT product IDs)' }, page_index: { type: 'integer', default: 1, description: 'Page number (10 results per page)' }, status: { type: 'string', description: 'Bug status filter. IMPORTANT: Only ONE status allowed per search. Values: O=Open, F=Fixed, T=Terminated. Do NOT use comma-separated values like "O,F".', enum: ['O', 'F', 'T'] }, severity: { type: 'string', description: 'Bug severity filter. Returns bugs with ONLY the specified severity level. Values: 1=Severity 1 (highest), 2=Severity 2, 3=Severity 3, 4=Severity 4, 5=Severity 5, 6=Severity 6 (lowest). For "severity 3 or higher" bugs, use multi_severity_search tool which handles multiple separate API calls.', enum: ['1', '2', '3', '4', '5', '6'] }, modified_date: { type: 'string', description: 'Last modified date filter. Values: 1=Last Week, 2=Last 30 Days, 3=Last 6 Months, 4=Last Year, 5=All. Default: 5 (All)', enum: ['1', '2', '3', '4', '5'], default: '5' }, sort_by: { type: 'string', description: 'Sort order for results. Default: modified_date (recent first)', enum: ['status', 'modified_date', 'severity', 'support_case_count', 'modified_date_earliest'] }, }, required: ['keyword'] }
- src/apis/bug-api.ts:660-722 (handler)Handles execution of search_bugs_by_keyword by constructing the Cisco Bug API endpoint `/bugs/keyword/{keyword}` with standard parameters and making the authenticated HTTP request.case 'search_bugs_by_keyword': endpoint = `/bugs/keyword/${encodeURIComponent(processedArgs.keyword)}`; break; case 'search_bugs_by_product_id': // Ensure forward slashes are properly encoded for product IDs like ISR4431-V/K9 const encodedBasePid = encodeURIComponent(processedArgs.base_pid).replace(/\//g, '%2F'); endpoint = `/bugs/products/product_id/${encodedBasePid}`; break; case 'search_bugs_by_product_and_release': // Ensure forward slashes are properly encoded for product IDs like ISR4431-V/K9 const encodedBasePidForRelease = encodeURIComponent(processedArgs.base_pid).replace(/\//g, '%2F'); endpoint = `/bugs/products/product_id/${encodedBasePidForRelease}/software_releases/${encodeURIComponent(processedArgs.software_releases)}`; break; case 'search_bugs_by_product_series_affected': endpoint = `/bugs/product_series/${encodeURIComponent(processedArgs.product_series)}/affected_releases/${encodeURIComponent(processedArgs.affected_releases)}`; break; case 'search_bugs_by_product_series_fixed': endpoint = `/bugs/product_series/${encodeURIComponent(processedArgs.product_series)}/fixed_in_releases/${encodeURIComponent(processedArgs.fixed_releases)}`; logger.info('Product series fixed endpoint', { product_series: processedArgs.product_series, fixed_releases: processedArgs.fixed_releases, endpoint, fullUrl: `${this.baseUrl}${endpoint}` }); break; case 'search_bugs_by_product_name_affected': endpoint = `/bugs/products/product_name/${encodeURIComponent(processedArgs.product_name)}/affected_releases/${encodeURIComponent(processedArgs.affected_releases)}`; break; case 'search_bugs_by_product_name_fixed': endpoint = `/bugs/products/product_name/${encodeURIComponent(processedArgs.product_name)}/fixed_in_releases/${encodeURIComponent(processedArgs.fixed_releases)}`; break; // Enhanced search tools case 'smart_search_strategy': return this.generateSearchStrategy(processedArgs); case 'progressive_bug_search': return this.executeProgressiveSearch(processedArgs, meta); case 'multi_severity_search': return this.executeMultiSeveritySearch(processedArgs, meta); case 'comprehensive_analysis': return this.executeComprehensiveAnalysis(processedArgs, meta); case 'compare_software_versions': return this.executeCompareSoftwareVersions(processedArgs, meta); case 'product_name_resolver': return this.executeProductNameResolver(processedArgs); default: throw new Error(`Tool implementation not found: ${name}`); } return await this.makeApiCall(endpoint, apiParams) as BugApiResponse; }
- src/apis/index.ts:117-141 (registration)ApiRegistry.getAvailableTools() collects tools from BugApi.getTools() (including search_bugs_by_keyword) and returns them for MCP tools/list.// In OAuth 2.1 mode, filter tools based on current request scopes let apisToUse = this.enabledApis; if (process.env.AUTH_TYPE === 'oauth2.1' && currentRequestScopes) { apisToUse = getEnabledAPIs(currentRequestScopes); } const availableTools: Tool[] = []; for (const apiName of apisToUse) { // Handle sampling tools specially (they're not in the apis map) if (apiName === 'sampling') { availableTools.push(...samplingTools); continue; } const api = this.apis.get(apiName); if (api) { const apiTools = api.getTools(); availableTools.push(...apiTools); } } return availableTools; }
- src/apis/index.ts:101-112 (registration)Instantiates BugApi instance in ApiRegistry, making its tools (including search_bugs_by_keyword) available.// Initialize implemented APIs this.apis.set('bug', new BugApi()); this.apis.set('case', new CaseApi()); this.apis.set('eox', new EoxApi()); this.apis.set('psirt', new PsirtApi()); this.apis.set('product', new ProductApi()); this.apis.set('software', new SoftwareApi()); this.apis.set('serial', new SerialApi()); this.apis.set('rma', new RmaApi()); this.apis.set('enhanced_analysis', new EnhancedAnalysisApi()); this.apis.set('smart_bonding', new SmartBondingApi() as any); // Cast needed due to different base class }
- src/utils/formatting.ts:383-384 (helper)formatSearchContext helper adds search context display for search_bugs_by_keyword results.if (searchContext.toolName === 'search_bugs_by_keyword' && searchContext.args.keyword) { formatted += `**Search Keywords:** "${searchContext.args.keyword}"\n\n`;