Skip to main content
Glama
Linked-API
by Linked-API

retrieve_connections

Retrieve LinkedIn connections with filters for names, positions, companies, locations, industries, and schools to organize and analyze your professional network.

Instructions

allows you to retrieve your connections and perform additional person-related actions if needed (st.retrieveConnections action).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoOptional. Number of connections to return. Defaults to 10, with a maximum value of 1000.
filterNoOptional. Object that specifies filtering criteria for people. When multiple filter fields are specified, they are combined using AND logic.

Implementation Reference

  • The RetrieveConnectionsTool class defines the tool implementation, including the name 'retrieve_connections', operationName, Zod input schema for validation, detailed inputSchema for the Tool interface, and description.
    export class RetrieveConnectionsTool extends OperationTool<
      TRetrieveConnectionsParams,
      TRetrieveConnectionsResult[]
    > {
      public override readonly name = 'retrieve_connections';
      public override readonly operationName = OPERATION_NAME.retrieveConnections;
      protected override readonly schema = z.object({
        limit: z.number().min(1).max(1000).optional(),
        filter: z
          .object({
            firstName: z.string().optional(),
            lastName: z.string().optional(),
            position: z.string().optional(),
            locations: z.array(z.string()).optional(),
            industries: z.array(z.string()).optional(),
            currentCompanies: z.array(z.string()).optional(),
            previousCompanies: z.array(z.string()).optional(),
            schools: z.array(z.string()).optional(),
          })
          .optional(),
      });
    
      public override getTool(): Tool {
        return {
          name: this.name,
          description:
            'allows you to retrieve your connections and perform additional person-related actions if needed (st.retrieveConnections action).',
          inputSchema: {
            type: 'object',
            properties: {
              limit: {
                type: 'number',
                description:
                  'Optional. Number of connections to return. Defaults to 10, with a maximum value of 1000.',
              },
              filter: {
                type: 'object',
                description:
                  'Optional. Object that specifies filtering criteria for people. When multiple filter fields are specified, they are combined using AND logic.',
                properties: {
                  firstName: {
                    type: 'string',
                    description: 'Optional. First name of person.',
                  },
                  lastName: {
                    type: 'string',
                    description: 'Optional. Last name of person.',
                  },
                  position: {
                    type: 'string',
                    description: 'Optional. Job position of person.',
                  },
                  locations: {
                    type: 'array',
                    description:
                      'Optional. Array of free-form strings representing locations. Matches if person is located in any of the listed locations.',
                    items: { type: 'string' },
                  },
                  industries: {
                    type: 'array',
                    description:
                      'Optional. Array of enums representing industries. Matches if person works in any of the listed industries. Takes specific values available in the LinkedIn interface.',
                    items: { type: 'string' },
                  },
                  currentCompanies: {
                    type: 'array',
                    description:
                      'Optional. Array of company names. Matches if person currently works at any of the listed companies.',
                    items: { type: 'string' },
                  },
                  previousCompanies: {
                    type: 'array',
                    description:
                      'Optional. Array of company names. Matches if person previously worked at any of the listed companies.',
                    items: { type: 'string' },
                  },
                  schools: {
                    type: 'array',
                    description:
                      'Optional. Array of institution names. Matches if person currently attends or previously attended any of the listed institutions.',
                    items: { type: 'string' },
                  },
                },
              },
            },
          },
        };
      }
    }
  • The LinkedApiTools class constructor instantiates RetrieveConnectionsTool (line 40) and registers it in the readonly tools array.
    constructor(progressCallback: (progress: LinkedApiProgressNotification) => void) {
      this.tools = [
        // Standard tools
        new SendMessageTool(progressCallback),
        new GetConversationTool(progressCallback),
        new CheckConnectionStatusTool(progressCallback),
        new RetrieveConnectionsTool(progressCallback),
        new SendConnectionRequestTool(progressCallback),
        new WithdrawConnectionRequestTool(progressCallback),
        new RetrievePendingRequestsTool(progressCallback),
        new RemoveConnectionTool(progressCallback),
        new SearchCompaniesTool(progressCallback),
        new SearchPeopleTool(progressCallback),
        new FetchCompanyTool(progressCallback),
        new FetchPersonTool(progressCallback),
        new FetchPostTool(progressCallback),
        new ReactToPostTool(progressCallback),
        new CommentOnPostTool(progressCallback),
        new CreatePostTool(progressCallback),
        new RetrieveSSITool(progressCallback),
        new RetrievePerformanceTool(progressCallback),
        // Sales Navigator tools
        new NvSendMessageTool(progressCallback),
        new NvGetConversationTool(progressCallback),
        new NvSearchCompaniesTool(progressCallback),
        new NvSearchPeopleTool(progressCallback),
        new NvFetchCompanyTool(progressCallback),
        new NvFetchPersonTool(progressCallback),
        // Other tools
        new ExecuteCustomWorkflowTool(progressCallback),
        new GetWorkflowResultTool(progressCallback),
        new GetApiUsageTool(progressCallback),
      ];
    }
  • Zod schema for validating the input parameters of the retrieve_connections tool: optional limit and detailed filter object.
    protected override readonly schema = z.object({
      limit: z.number().min(1).max(1000).optional(),
      filter: z
        .object({
          firstName: z.string().optional(),
          lastName: z.string().optional(),
          position: z.string().optional(),
          locations: z.array(z.string()).optional(),
          industries: z.array(z.string()).optional(),
          currentCompanies: z.array(z.string()).optional(),
          previousCompanies: z.array(z.string()).optional(),
          schools: z.array(z.string()).optional(),
        })
        .optional(),
    });
  • The execute method from the base OperationTool class, inherited by RetrieveConnectionsTool, which locates the specific retrieveConnections operation and executes it with progress reporting.
      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,
        });
      }
    }
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden but offers minimal behavioral insight. It mentions retrieving connections but doesn't disclose pagination behavior, rate limits, authentication requirements, or what 'additional person-related actions' entails. The description is insufficient for a tool with potential complexity.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is brief but contains redundant phrasing ('allows you to retrieve') and confusing elements ('perform additional person-related actions if needed'). The parenthetical reference to 'st.retrieveConnections action' adds technical noise without clarifying purpose. It's neither efficiently concise nor well-structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with 2 parameters (including a complex nested filter object), no annotations, and no output schema, the description is inadequate. It doesn't explain what constitutes a 'connection', how results are returned, or what the 'additional actions' might be. The agent lacks sufficient context to use this tool effectively.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema fully documents both parameters (limit and filter). The description adds no parameter information beyond what's already in the structured schema, meeting the baseline expectation but not providing additional value.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states the tool 'retrieve your connections' which clarifies the verb and resource, but it's vague about what 'perform additional person-related actions if needed' means. It doesn't clearly distinguish this from sibling tools like 'fetch_person' or 'search_people', leaving ambiguity about its specific scope.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No explicit guidance on when to use this tool versus alternatives like 'fetch_person', 'search_people', or 'check_connection_status'. The mention of 'additional person-related actions' is too vague to provide meaningful context for tool selection.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Linked-API/linkedapi-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server