Skip to main content
Glama
CodeDreamer06

MonkeyType MCP Server

get_profile

Retrieve user profile information from MonkeyType by providing a UID or username. Use 'me' to access your own profile data from the typing platform.

Instructions

Get user's profile information

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uidOrNameNoThe UID or username of the user. If omitted or set to a keyword like 'me', 'self', 'current', or 'my', the value from the MONKEYTYPE_USERNAME environment variable will be used.

Implementation Reference

  • Handler for the 'get_profile' tool: resolves user identifier from input or environment variable and fetches profile from MonkeyType API.
    case "get_profile": {
      let targetUidOrName;
      const keywordsForCurrentUser = ["me", "self", "current", "my"];
    
      if (args.uidOrName) {
        if (keywordsForCurrentUser.includes(args.uidOrName.toLowerCase())) {
          targetUidOrName = process.env.MONKEYTYPE_USERNAME;
          if (!targetUidOrName) {
            throw new Error('uidOrName specified as current user, but MONKEYTYPE_USERNAME environment variable is not set.');
          }
        } else {
          targetUidOrName = args.uidOrName; // Use the explicitly provided uidOrName
        }
      } else {
        // No uidOrName argument provided, try to use the environment variable
        targetUidOrName = process.env.MONKEYTYPE_USERNAME;
        if (!targetUidOrName) {
          throw new Error('uidOrName parameter is required, or MONKEYTYPE_USERNAME environment variable must be set.');
        }
      }
    
      // Final check to ensure targetUidOrName is a non-empty string
      if (!targetUidOrName || typeof targetUidOrName !== 'string' || targetUidOrName.trim() === '') {
          throw new Error('Could not determine a valid UID/username. Please provide the uidOrName parameter or set the MONKEYTYPE_USERNAME environment variable with a non-empty value.');
      }
    
      const result = await callMonkeyTypeApi(`/users/${targetUidOrName}/profile`, 'GET', apiKey, {});
      return {
        content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
      };
    }
  • Zod schema defining the input parameters for the get_profile tool.
    const GetProfileSchema = BaseApiSchema.extend({
      uidOrName: z.string().optional().describe("The UID or username of the user. If omitted or set to a keyword like 'me', 'self', 'current', or 'my', the value from the MONKEYTYPE_USERNAME environment variable will be used.")
    });
  • server.js:183-187 (registration)
    Registration of the 'get_profile' tool in the MCP server's tool list, including name, description, and input schema.
    {
      name: "get_profile",
      description: "Get user's profile information",
      inputSchema: zodToJsonSchema(GetProfileSchema),
    },
Behavior2/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 only states the basic action. It doesn't mention authentication requirements, rate limits, error conditions, what specific profile information is returned, or whether this is a read-only operation (though implied by 'Get'). For a tool with zero annotation coverage, this is insufficient behavioral context.

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 at just four words, front-loading the essential information with zero wasted words. Every element ('Get', 'user's', 'profile', 'information') contributes directly to understanding the tool's purpose without unnecessary elaboration.

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 no annotations, no output schema, and multiple similar sibling tools, the description is inadequate. It doesn't explain what 'profile information' includes, how it differs from other user data tools, what authentication is needed, or what the return format looks like. The context demands more completeness than this minimal description provides.

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?

The description adds no parameter information beyond what's already in the schema, which has 100% coverage. The schema fully documents the single parameter's purpose, optional nature, and special keyword behavior. The description doesn't compensate with additional context about parameter usage or implications, so it meets the baseline for high schema coverage.

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

Purpose4/5

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

The description clearly states the verb ('Get') and resource ('user's profile information'), making the purpose immediately understandable. However, it doesn't distinguish this tool from potential siblings like 'get_stats' or 'get_typing_stats' that might also retrieve user information, so it doesn't reach the highest level of sibling differentiation.

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?

The description provides no guidance on when to use this tool versus alternatives. With multiple sibling tools like 'get_stats', 'get_typing_stats', and 'get_streak' that might retrieve overlapping user information, there's no indication of what makes 'get_profile' distinct or when it should be preferred over other 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

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/CodeDreamer06/MonkeytypeMCP'

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