Skip to main content
Glama
gologinapp

GoLogin MCP

Official
by gologinapp

get_profile_v2

Retrieve and organize GoLogin browser profiles by searching, filtering, and sorting based on criteria like last activity, proxy type, creation date, or tags. Access profiles efficiently for automation and management purposes.

Instructions

Get all profiles

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
folderNo
pageNo
searchNo
sorterFieldNo
sorterOrderNo
tagNo

Implementation Reference

  • The core handler function that executes the logic for the 'get_profile_v2' tool (and all dynamic tools). It matches the tool name to an OpenAPI path and method, constructs the HTTP request (URL with path/query params, body, headers incl. auth token), calls the GoLogin API via fetch, and formats the response.
    private async callDynamicTool(
      toolName: string,
      parameters: CallParameters = {},
      headers: Record<string, string> = {}
    ): Promise<CallToolResult> {
      console.log('parameters', parameters.body);
      if (!this.apiSpec || !this.apiSpec.paths) {
        throw new Error('API specification not loaded');
      }
    
      let targetPath = '';
      let targetMethod = '';
      let operation: OpenAPIV3.OperationObject | undefined;
    
      for (const [path, pathItem] of Object.entries(this.apiSpec.paths)) {
        if (!pathItem) continue;
    
        for (const [method, op] of Object.entries(pathItem)) {
          if (['get', 'post', 'put', 'delete', 'patch', 'head', 'options'].includes(method) && op) {
            const opObj = op as OpenAPIV3.OperationObject;
            const generatedToolName = `${method}${path.replace('browser', 'profile').replace(/[^a-zA-Z0-9]/g, '_')}`;
    
            if (generatedToolName === toolName) {
              targetPath = path;
              targetMethod = method.toUpperCase();
              operation = opObj;
              break;
            }
          }
        }
        if (operation) break;
      }
    
    
      if (!operation) {
        throw new Error(`Tool "${toolName}" not found`);
      }
    
      let url = `${this.baseUrl}${targetPath}`;
      const requestHeaders: Record<string, string> = { ...headers };
      let requestBody: string | undefined;
    
      requestHeaders['User-Agent'] = 'gologin-mcp';
      console.error('this.token', this.token);
      if (this.token) {
        requestHeaders['Authorization'] = `Bearer ${this.token}`;
      }
    
      if (parameters.path) {
        for (const [key, value] of Object.entries(parameters.path)) {
          url = url.replace(`{${key}}`, encodeURIComponent(value));
        }
      }
    
      const queryParams = new URLSearchParams();
      if (parameters.query) {
        for (const [key, value] of Object.entries(parameters.query)) {
          if (value) {
            queryParams.append(key, value);
          }
        }
      }
    
      if (queryParams.toString()) {
        url += `?${queryParams.toString()}`;
      }
      if (parameters.body && ['POST', 'PUT', 'PATCH', 'DELETE'].includes(targetMethod)) {
        requestHeaders['Content-Type'] = 'application/json';
        requestBody = JSON.stringify(parameters.body);
      }
      console.log('requestBody', requestBody);
      try {
        const fetchOptions: RequestInit = {
          method: targetMethod,
          headers: requestHeaders,
        };
        console.error('fetchOptions', fetchOptions);
        if (requestBody) {
          fetchOptions.body = requestBody;
        }
        const response = await fetch(url, fetchOptions);
    
        const responseHeaders: Record<string, string> = {};
        response.headers.forEach((value, key) => {
          responseHeaders[key] = value;
        });
    
        let responseBody: any;
        const contentType = response.headers.get('content-type') || '';
    
    
        if (contentType.includes('application/json')) {
          try {
            responseBody = await response.json();
          } catch {
            responseBody = await response.text();
          }
        } else {
          responseBody = await response.text();
        }
        return {
          content: [
            {
              type: 'text',
              text: `API Call Result:\n` +
                `URL: ${url}\n` +
                `Method: ${targetMethod}\n` +
                `Status: ${response.status} ${response.statusText}\n\n` +
                `Response Headers:\n${JSON.stringify(responseHeaders, null, 2)}\n\n` +
                `Response Body:\n${typeof responseBody === 'object' ? JSON.stringify(responseBody, null, 2) : responseBody}`,
            },
          ],
        };
      } catch (error) {
        throw new Error(`API call failed: ${error instanceof Error ? error.message : String(error)}`);
      }
    }
  • src/index.ts:47-72 (registration)
    Registers the tools/list handler, which dynamically generates the list of available tools, including 'get_profile_v2', by iterating OpenAPI paths, replacing 'browser' with 'profile' in paths, sanitizing, and creating tool names like 'get_profile_v2', along with input schemas.
    this.server.setRequestHandler(ListToolsRequestSchema, async () => {
      const tools: Tool[] = [];
      if (this.apiSpec && this.apiSpec.paths) {
        for (const [path, pathItem] of Object.entries(this.apiSpec.paths)) {
          if (!pathItem) continue;
    
          for (const [method, operation] of Object.entries(pathItem)) {
            if (['get', 'post', 'put', 'delete', 'patch', 'head', 'options'].includes(method) && operation) {
              const op = operation as OpenAPIV3.OperationObject;
              const toolName = `${method}${path.replace('browser', 'profile').replace(/[^a-zA-Z0-9]/g, '_')}`;
    
              const inputSchema = this.buildInputSchema(op, path);
    
              tools.push({
                name: toolName,
                description: op.summary || op.description || `${method.toUpperCase()} ${path}`,
                inputSchema,
              });
            }
          }
        }
      }
    
      return { tools };
    });
  • src/index.ts:73-93 (registration)
    Registers the tools/call handler, which receives tool calls, extracts parameters from arguments for dynamic tools like 'get_profile_v2', and delegates to the callDynamicTool handler.
    this.server.setRequestHandler(CallToolRequestSchema, async (request: any): Promise<CallToolResult> => {
      const { name, arguments: args } = request.params;
    
      if (!args) {
        throw new Error('No arguments provided');
      }
      console.log('args', args);
      try {
        const parameters: CallParameters = this.extractParametersFromArgs(name, args);
        return await this.callDynamicTool(name, parameters, args.headers as Record<string, string> | undefined);
      } catch (error) {
        return {
          content: [
            {
              type: 'text',
              text: `Error: ${error instanceof Error ? error.message : String(error)}`,
            },
          ],
        };
      }
    });
  • Builds the JSON schema for tool inputs (e.g., for 'get_profile_v2') by extracting path, query, and body parameters from the corresponding OpenAPI operation.
    private buildInputSchema(operation: OpenAPIV3.OperationObject, path: string): any {
      const properties: any = {};
      const required: string[] = [];
    
      const pathParams = this.extractPathParameters(operation, path);
      const queryParams = this.extractQueryParameters(operation);
      const bodySchema = this.extractRequestBodySchema(operation);
    
      if (pathParams.properties && Object.keys(pathParams.properties).length > 0) {
        for (const [key, prop] of Object.entries(pathParams.properties)) {
          properties[key] = this.convertOpenAPISchemaToJsonSchema(prop as OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject);
          if (pathParams.required.includes(key)) {
            required.push(key);
          }
        }
      }
    
      if (queryParams.properties && Object.keys(queryParams.properties).length > 0) {
        for (const [key, prop] of Object.entries(queryParams.properties)) {
          properties[key] = this.convertOpenAPISchemaToJsonSchema(prop as OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject);
          if (queryParams.required.includes(key)) {
            required.push(key);
          }
        }
      }
    
      if (bodySchema && bodySchema.properties) {
        for (const [key, prop] of Object.entries(bodySchema.properties)) {
          properties[key] = this.convertOpenAPISchemaToJsonSchema(prop as OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject);
          if (bodySchema.required && bodySchema.required.includes(key)) {
            required.push(key);
          }
        }
      }
    
      const schema: any = {
        type: 'object',
        properties,
      };
    
      if (required.length > 0) {
        schema.required = required;
      }
    
      return schema;
    }
  • Helper function that parses tool arguments into path, query, and body parameters by matching against the OpenAPI operation for the tool name like 'get_profile_v2'.
    private extractParametersFromArgs(toolName: string, args: Record<string, any>): CallParameters {
      if (!this.apiSpec || !this.apiSpec.paths) {
        return { body: args };
      }
    
      let operation: OpenAPIV3.OperationObject | undefined;
      let path = '';
    
      for (const [apiPath, pathItem] of Object.entries(this.apiSpec.paths)) {
        if (!pathItem) continue;
    
        for (const [method, op] of Object.entries(pathItem)) {
          if (['get', 'post', 'put', 'delete', 'patch', 'head', 'options'].includes(method) && op) {
            const opObj = op as OpenAPIV3.OperationObject;
            const generatedToolName = opObj.operationId || `${method}_${apiPath.replace(/[^a-zA-Z0-9]/g, '_')}`;
    
            if (generatedToolName === toolName) {
              operation = opObj;
              path = apiPath;
              break;
            }
          }
        }
        if (operation) break;
      }
    
      if (!operation) {
        return { body: args };
      }
    
      const pathParams: Record<string, string> = {};
      const queryParams: Record<string, string> = {};
      const bodyParams: any = {};
    
      const pathParamNames = path.match(/\{([^}]+)\}/g)?.map(p => p.slice(1, -1)) || [];
    
      if (operation.parameters) {
        operation.parameters.forEach(param => {
          if ('$ref' in param) return;
    
          const parameter = param as OpenAPIV3.ParameterObject;
          const paramName = parameter.name;
    
          if (parameter.in === 'path' && args[paramName] !== undefined) {
            pathParams[paramName] = String(args[paramName]);
          } else if (parameter.in === 'query' && args[paramName] !== undefined) {
            queryParams[paramName] = String(args[paramName]);
          }
        });
      }
    
      pathParamNames.forEach(paramName => {
        if (args[paramName] !== undefined && !pathParams[paramName]) {
          pathParams[paramName] = String(args[paramName]);
        }
      });
    
      const usedParams = new Set([...Object.keys(pathParams), ...Object.keys(queryParams)]);
      for (const [key, value] of Object.entries(args)) {
        if (!usedParams.has(key)) {
          bodyParams[key] = value;
        }
      }
    
      const parameters: CallParameters = {};
    
      if (Object.keys(pathParams).length > 0) {
        parameters.path = pathParams;
      }
    
      if (Object.keys(queryParams).length > 0) {
        parameters.query = queryParams;
      }
    
      if (Object.keys(bodyParams).length > 0) {
        parameters.body = bodyParams;
      }
    
      return parameters;
    }
Behavior1/5

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

With no annotations provided, the description carries full burden for behavioral disclosure but offers none. 'Get all profiles' doesn't indicate whether this is a read-only operation, how results are returned (e.g., paginated, filtered), what permissions are required, or any rate limits. For a tool with 6 parameters that presumably supports complex queries, this lack of behavioral context is inadequate.

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

Conciseness2/5

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

While technically concise with only three words, this is under-specification rather than effective brevity. The description lacks necessary structure—it doesn't front-load key information about what the tool actually does beyond the obvious, nor does it provide any context about parameters, behavior, or usage. Every word should earn its place, but here the words don't provide enough value.

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

Completeness1/5

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

Given the tool's complexity (6 parameters with enums, no output schema, no annotations), the description is completely inadequate. It doesn't explain what 'profiles' are in this context, how results are structured, what filtering/sorting/pagination options exist via parameters, or how this differs from sibling profile retrieval tools. For a multi-parameter query tool, this minimal description leaves critical gaps.

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

Parameters1/5

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

The description provides zero information about any of the 6 parameters, despite 0% schema description coverage. Parameters like 'folder', 'search', 'tag', 'sorterField', 'sorterOrder', and 'page' are completely undocumented in both schema and description, leaving their purpose, format, and usage ambiguous. The description fails to compensate for the schema's lack of parameter documentation.

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

Purpose2/5

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

The description 'Get all profiles' is a tautology that restates the tool name 'get_profile_v2' without adding meaningful specificity. It doesn't distinguish this tool from sibling tools like 'get_profile__id_' (get single profile) or 'get_deleted_profiles_v2' (get deleted profiles), nor does it specify what kind of profiles or what 'all' means in context.

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

Usage Guidelines1/5

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

The description provides no guidance on when to use this tool versus alternatives. With multiple sibling tools for retrieving profiles (e.g., 'get_profile__id_' for single profiles, 'get_deleted_profiles_v2' for deleted ones, 'get_workspaces__wid__profiles' for workspace-specific profiles), the description fails to indicate when this bulk retrieval tool is appropriate versus more targeted options.

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

Related 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/gologinapp/gologin-mcp'

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