Skip to main content
Glama

clipboard_read

Read-only

Read macOS clipboard contents as plain text to access copied data for automation tasks.

Instructions

Read the current contents of the macOS clipboard as plain text.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The handler function that executes the `clipboard_read` tool logic by calling the `clipboardRead` helper.
    async function handleClipboardRead(): Promise<CallToolResult> {
      const text = await clipboardRead();
    
      return {
        content: [
          {
            type: "text" as const,
            text: JSON.stringify({ text }),
          },
        ],
      };
    }
  • The implementation of `clipboardRead` helper which executes `pbpaste`.
    export async function clipboardRead(): Promise<string> {
      const { stdout } = await execFileAsync("pbpaste", [], {
        timeout: CLIPBOARD_TIMEOUT_MS,
      });
      return stdout;
    }
  • Definition of the `clipboard_read` tool.
    {
      name: "clipboard_read",
      description:
        "Read the current contents of the macOS clipboard as plain text.",
      inputSchema: zodToToolInputSchema(ClipboardReadInputSchema),
      annotations: {
        readOnlyHint: true,
        destructiveHint: false,
      },
    },
  • Input schema for `clipboard_read`.
    const ClipboardReadInputSchema = z.object({});
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, indicating a safe read operation. The description adds valuable context by specifying 'macOS clipboard' and 'plain text', which are not covered by annotations. It does not contradict annotations and provides useful platform and format details.

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 zero waste. It is front-loaded with the core action and resource, making it highly concise and well-structured for quick understanding.

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

Completeness4/5

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

Given the tool's simplicity (0 parameters, no output schema, and clear annotations), the description is mostly complete. It specifies the platform (macOS) and output format (plain text), but could note potential limitations like empty clipboard or non-text content handling. However, for a read-only tool, it covers essential context adequately.

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

Parameters4/5

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

With 0 parameters and 100% schema description coverage, the baseline is 4. The description adds no parameter information (as there are none), which is appropriate and does not detract from the schema's completeness.

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

Purpose5/5

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

The description clearly states the specific action ('Read') and resource ('contents of the macOS clipboard as plain text'), distinguishing it from sibling tools like clipboard_write. It precisely defines the tool's function without ambiguity.

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

Usage Guidelines4/5

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

The description implies usage context (when you need clipboard contents), but does not explicitly state when to use this tool versus alternatives like type_text or press_key. It provides clear intent but lacks explicit guidance on exclusions or comparisons with siblings.

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/antbotlab/mac-use-mcp'

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