Skip to main content
Glama
gologinapp

GoLogin MCP

Official
by gologinapp

get_workspaces__wid__profiles

Retrieve all profiles within a specific workspace using customizable search, sorting, and filtering options to manage and organize browser profiles effectively.

Instructions

Get all profiles in workspace

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
folderNo
folderIdNo
isAndroidCloudNo
offsetNo
pageNo
searchNo
sortFieldNo
sortOrderNo
tagNo
widYes

Implementation Reference

  • src/index.ts:47-71 (registration)
    Dynamically generates and registers the 'get_workspaces__wid__profiles' tool (from GET /workspaces/{wid}/profiles in OpenAPI spec) in the listTools handler using path normalization to create the tool name.
    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 };
    });
  • Executes the tool by matching 'get_workspaces__wid__profiles' to the corresponding OpenAPI GET /workspaces/{wid}/profiles operation, extracts parameters (path param 'wid'), constructs the URL, adds auth if token present, and performs HTTP GET request to GoLogin API, returning 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)}`);
      }
    }
  • Dynamically builds the input schema for the tool from OpenAPI operation, extracting path params like 'wid', query params, and request body schema.
    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 to parse tool call arguments into path/query/body parameters by reverse-matching toolName to OpenAPI path/operation.
    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;
    }
Behavior2/5

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

No annotations are provided, so the description carries full burden. It states 'Get all profiles' but doesn't clarify if this is a paginated list, what the response format is, whether it requires authentication, or any rate limits. For a tool with 10 parameters and no output schema, this leaves critical behavioral aspects undocumented.

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

Conciseness5/5

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

The description is extremely concise with a single sentence 'Get all profiles in workspace'. It's front-loaded and wastes no words, though this brevity contributes to its inadequacy in other dimensions. Every word earns its place, but more content is needed for completeness.

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?

Given the complexity (10 parameters, no annotations, no output schema, many siblings), the description is incomplete. It doesn't explain what 'profiles' are, how results are returned, or how to use filtering/sorting parameters. For a list operation with rich input options, this leaves too much unsaid for effective agent use.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must compensate but fails to do so. It mentions no parameters, leaving all 10 (including complex ones like 'sortField' with enums, 'offset', 'page', 'search', 'tag') undocumented. The description adds no meaning beyond the bare schema, which is insufficient given the low coverage.

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 'Get all profiles in workspace' clearly states the action (get) and resource (profiles in workspace), but it's vague about scope and doesn't distinguish from sibling tools like 'get_workspaces__wid__profiles_count' or 'get_profile_v2'. It doesn't specify whether this retrieves all profiles at once or with pagination, leaving ambiguity.

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 guidance is provided on when to use this tool versus alternatives. With many sibling tools like 'get_profile_v2', 'get_deleted_profiles_v2', and 'get_workspaces__wid__profiles_count', there's no indication of how this tool differs or when it's preferred, leaving the agent to guess based on naming alone.

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