Skip to main content
Glama
CodeDreamer06

MonkeyType MCP Server

get_results

Retrieve typing test results from MonkeyType to analyze performance metrics, track progress, and review past typing sessions.

Instructions

Get user's typing test results

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
timestampNoTimestamp of the earliest result to fetch
offsetNoOffset of the item at which to begin the response
limitNoLimit results to the given amount

Implementation Reference

  • The switch case handler for the 'get_results' tool, which constructs query parameters from input (timestamp, offset, limit) and calls the shared callMonkeyTypeApi function to fetch typing test results from the '/results' endpoint.
    case "get_results": {
      const params = {};
      if (args.timestamp) params.timestamp = args.timestamp;
      if (args.offset) params.offset = args.offset;
      if (args.limit) params.limit = args.limit;
      
      const result = await callMonkeyTypeApi('/results', 'GET', apiKey, params);
      return {
        content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
      };
    }
  • Zod input schema for the 'get_results' tool, defining optional parameters: timestamp, offset, and limit.
    const GetResultsSchema = BaseApiSchema.extend({
      timestamp: z.number().optional().describe("Timestamp of the earliest result to fetch"),
      offset: z.number().optional().describe("Offset of the item at which to begin the response"),
      limit: z.number().optional().describe("Limit results to the given amount")
    });
  • server.js:205-209 (registration)
    Tool registration in the ListToolsRequestHandler response, specifying name, description, and converted JSON schema.
    {
      name: "get_results",
      description: "Get user's typing test results",
      inputSchema: zodToJsonSchema(GetResultsSchema),
    },
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 states a read operation ('Get') but doesn't disclose authentication needs, rate limits, pagination behavior, error conditions, or what 'user's' implies (e.g., current authenticated user). This is inadequate for a tool with parameters and no output schema.

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 a single, efficient sentence with no wasted words. It's front-loaded and appropriately sized for its purpose, earning full marks for conciseness.

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 3 parameters, no annotations, and no output schema, the description is incomplete. It doesn't explain return values, error handling, or behavioral traits, leaving significant gaps for the agent. For a data retrieval tool with multiple parameters, more context is needed to be fully helpful.

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 parameters are fully documented in the schema. The description adds no additional meaning beyond implying results are fetched, which the schema already covers with its parameter descriptions. Baseline 3 is appropriate as the schema does the heavy lifting.

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 user's typing test results' clearly states the action (get) and resource (typing test results), but it's somewhat vague about scope and doesn't differentiate from siblings like get_last_result, get_result_by_id, or get_personal_bests. It doesn't specify whether this retrieves all results, recent results, or filtered results beyond what parameters indicate.

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 like get_last_result or get_result_by_id. The description implies fetching multiple results but doesn't clarify context, prerequisites, or exclusions, leaving the agent to infer usage from parameters 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

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