Skip to main content
Glama

basic_auth

Validate and test basic authentication mechanisms by verifying username and password inputs to identify potential security vulnerabilities in API endpoints.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
passwordYesPassword for authentication
usernameYesUsername for authentication

Implementation Reference

  • Registers the basic_auth tool with input schema (username, password) and inline handler that sets the authentication state using AuthManager
    server.tool(
      "basic_auth",
      {
        username: z.string().describe("Username for authentication"),
        password: z.string().describe("Password for authentication"),
      },
      async ({ username, password }) => {
        try {
          const authManager = AuthManager.getInstance();
          const authState = await authManager.setBasicAuth({ username, password });
          
          return {
            content: [
              {
                type: "text",
                text: `Successfully set Basic authentication with username: ${username}\nAuthentication type: ${authState.type}\nHeader: Authorization: Basic ***`,
              },
            ],
          };
        } catch (error) {
          return {
            content: [
              {
                type: "text",
                text: `Error setting Basic authentication: ${(error as Error).message}`,
              },
            ],
          };
        }
      }
    );
  • Tool handler function that invokes AuthManager to set Basic Auth credentials and returns formatted response
    async ({ username, password }) => {
      try {
        const authManager = AuthManager.getInstance();
        const authState = await authManager.setBasicAuth({ username, password });
        
        return {
          content: [
            {
              type: "text",
              text: `Successfully set Basic authentication with username: ${username}\nAuthentication type: ${authState.type}\nHeader: Authorization: Basic ***`,
            },
          ],
        };
      } catch (error) {
        return {
          content: [
            {
              type: "text",
              text: `Error setting Basic authentication: ${(error as Error).message}`,
            },
          ],
        };
      }
    }
  • Zod input schema defining username and password parameters for the basic_auth tool
    {
      username: z.string().describe("Username for authentication"),
      password: z.string().describe("Password for authentication"),
    },
  • AuthManager.setBasicAuth method: core implementation that encodes credentials to Base64 and updates authentication state
    public async setBasicAuth(credentials: BasicAuthCredentials): Promise<AuthState> {
      const { username, password } = credentials;
      
      // Create Base64 encoded credentials
      const base64Credentials = Buffer.from(`${username}:${password}`).toString('base64');
      
      this.authState = {
        type: 'basic',
        username,
        password,
        headers: {
          'Authorization': `Basic ${base64Credentials}`
        }
      };
      
      return this.getAuthState();
    }
  • Type definition for BasicAuthCredentials used by the basic_auth tool and handler
    export interface BasicAuthCredentials {
      username: string;
      password: string;
    }
  • Top-level registration call that includes the authentication tools (including basic_auth) via registerAuthenticationTools
    registerAuthenticationTools(server);
Behavior1/5

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

Tool has no description.

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

Conciseness1/5

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

Tool has no description.

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?

Tool has no description.

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?

Tool has no description.

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

Purpose1/5

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

Tool has no description.

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?

Tool has no description.

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/ricauts/CyberMCP'

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