nv_search_companies
Search for companies in Sales Navigator using filters like size, location, industry, and revenue. Combine criteria with AND logic to find targeted prospects.
Instructions
Allows you to search for companies in Sales Navigator applying various filtering criteria. (nv.searchCompanies action).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| term | No | Optional. Keyword or phrase to search. | |
| limit | No | Optional. Number of search results to return. Defaults to 25, with a maximum value of 1000. | |
| filter | No | Optional. Object that specifies filtering criteria for companies. When multiple filter fields are specified, they are combined using AND logic. |
Implementation Reference
- src/utils/linked-api-tool.ts:36-58 (handler)Base class OperationTool provides the execute() method that all operation-based tools inherit. It looks up the matching operation by operationName and delegates to executeWithProgress.
export abstract class OperationTool<TParams, TResult> extends LinkedApiTool<TParams, TResult> { public abstract readonly operationName: TOperationName; public override execute({ linkedapi, args, workflowTimeout, progressToken, }: { linkedapi: LinkedApi; args: TParams; workflowTimeout: number; progressToken?: string | number; }): Promise<TMappedResponse<TResult>> { const operation = linkedapi.operations.find( (operation) => operation.operationName === this.operationName, )! as Operation<TParams, TResult>; return executeWithProgress(this.progressCallback, operation, workflowTimeout, { params: args, progressToken, }); } } - src/tools/nv-search-companies.ts:7-114 (handler)Concrete tool class for 'nv_search_companies'. Sets the tool name, operation name (nvSearchCompanies), defines the Zod validation schema, and provides the MCP Tool definition (description + inputSchema). The execute() method is inherited from OperationTool.
export class NvSearchCompaniesTool extends OperationTool<TNvSearchCompaniesParams, unknown> { public override readonly name = 'nv_search_companies'; public override readonly operationName = OPERATION_NAME.nvSearchCompanies; protected override readonly schema = z.object({ term: z.string().optional(), limit: z.number().min(1).max(1000).optional(), filter: z .object({ locations: z.array(z.string()).optional(), industries: z.array(z.string()).optional(), sizes: z .array( z.enum([ '1-10', '11-50', '51-200', '201-500', '501-1000', '1001-5000', '5001-10000', '10001+', ]), ) .optional(), annualRevenue: z .object({ min: z.string().optional(), max: z.string().optional(), }) .optional(), }) .optional(), }); public override getTool(): Tool { return { name: this.name, description: 'Allows you to search for companies in Sales Navigator applying various filtering criteria. (nv.searchCompanies action).', inputSchema: { type: 'object', properties: { term: { type: 'string', description: 'Optional. Keyword or phrase to search.', }, limit: { type: 'number', description: 'Optional. Number of search results to return. Defaults to 25, with a maximum value of 1000.', }, filter: { type: 'object', description: 'Optional. Object that specifies filtering criteria for companies. When multiple filter fields are specified, they are combined using AND logic.', properties: { sizes: { type: 'array', description: 'Optional. Array of enums representing employee count ranges. Matches if company size falls within any of the listed ranges.', items: { type: 'string', enum: [ '1-10', '11-50', '51-200', '201-500', '501-1000', '1001-5000', '5001-10000', '10001+', ], }, }, locations: { type: 'array', description: 'Optional. Array of free-form strings representing locations. Matches if company is headquartered in any of the listed locations.', items: { type: 'string' }, }, industries: { type: 'array', description: 'Optional. Array of enums representing industries. Matches if company works in any of the listed industries. Takes specific values available in the LinkedIn interface.', items: { type: 'string' }, }, annualRevenue: { type: 'object', description: 'Optional. Object representing company annual revenue range in million USD.', properties: { min: { type: 'string', enum: ['0', '0.5', '1', '2.5', '5', '10', '20', '50', '100', '500', '1000'], }, max: { type: 'string', enum: ['0.5', '1', '2.5', '5', '10', '20', '50', '100', '500', '1000', '1000+'], }, }, }, }, }, }, }, }; } } - Zod schema for validating tool input parameters: term (string), limit (number 1-1000), and filter (locations, industries, sizes, annualRevenue).
protected override readonly schema = z.object({ term: z.string().optional(), limit: z.number().min(1).max(1000).optional(), filter: z .object({ locations: z.array(z.string()).optional(), industries: z.array(z.string()).optional(), sizes: z .array( z.enum([ '1-10', '11-50', '51-200', '201-500', '501-1000', '1001-5000', '5001-10000', '10001+', ]), ) .optional(), annualRevenue: z .object({ min: z.string().optional(), max: z.string().optional(), }) .optional(), }) .optional(), }); - src/linked-api-tools.ts:70-70 (registration)Registration: The NvSearchCompaniesTool is instantiated and added to the tools array in LinkedApiTools constructor, making it available for dispatch via toolByName().
new NvSearchCompaniesTool(progressCallback), - Helper that wraps operation execution with progress notifications. Calls the LinkedApi operation's execute/result methods and reports progress via callback.
export async function executeWithProgress<TParams, TResult>( progressCallback: (progress: LinkedApiProgressNotification) => void, operation: Operation<TParams, TResult>, workflowTimeout: number, { params, workflowId, progressToken, }: { params?: TParams; workflowId?: string; progressToken?: string | number } = {}, ): Promise<TMappedResponse<TResult>> { let progress = 0; progressCallback({ progressToken, progress, total: 100, message: `Starting workflow ${operation.operationName}...`, }); const interval = setInterval( () => { if (progress < 50) { progress += 5; } else if (progress < 98) { progress += 1; } progressCallback({ progressToken, progress, total: 100, message: `Executing workflow ${operation.operationName}...`, }); }, Math.max(workflowTimeout / 20, 10000), ); try { if (!workflowId) { workflowId = await operation.execute(params as TParams); } const result = await operation.result(workflowId, { timeout: workflowTimeout, }); clearInterval(interval); progressCallback({ progressToken, progress: 100, total: 100, message: `Workflow ${operation.operationName} completed successfully`, }); return result; } catch (error) { clearInterval(interval); if (error instanceof LinkedApiWorkflowTimeoutError) { throw generateTimeoutError(error); } throw error; } }