Skip to main content
Glama

join_channel

Connect to a specific Figma channel to enable communication between Cursor AI and Figma designs for programmatic reading and modification.

Instructions

Join a specific channel to communicate with Figma

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
channelNoThe name of the channel to join

Implementation Reference

  • MCP tool registration for 'join_channel', including schema and handler function that calls joinChannel to connect to a WebSocket channel for Figma communication.
    server.tool(
      "join_channel",
      "Join a specific channel to communicate with Figma",
      {
        channel: z.string().describe("The name of the channel to join").default(""),
      },
      async ({ channel }) => {
        try {
          if (!channel) {
            // If no channel provided, ask the user for input
            return {
              content: [
                {
                  type: "text",
                  text: "Please provide a channel name to join:",
                },
              ],
              followUp: {
                tool: "join_channel",
                description: "Join the specified channel",
              },
            };
          }
    
          await joinChannel(channel);
          return {
            content: [
              {
                type: "text",
                text: `Successfully joined channel: ${channel}`,
              },
            ],
          };
        } catch (error) {
          return {
            content: [
              {
                type: "text",
                text: `Error joining channel: ${error instanceof Error ? error.message : String(error)
                  }`,
              },
            ],
          };
        }
      }
    );
  • Handler helper function 'joinChannel' that sends the 'join' command via WebSocket to the socket server, setting the current channel.
    async function joinChannel(channelName: string): Promise<void> {
      if (!ws || ws.readyState !== WebSocket.OPEN) {
        throw new Error("Not connected to Figma");
      }
    
      try {
        await sendCommandToFigma("join", { channel: channelName });
        currentChannel = channelName;
        logger.info(`Joined channel: ${channelName}`);
      } catch (error) {
        logger.error(`Failed to join channel: ${error instanceof Error ? error.message : String(error)}`);
        throw error;
      }
    }
  • Zod schema for join_channel tool input: channel name (string, default empty).
    {
      channel: z.string().describe("The name of the channel to join").default(""),
  • WebSocket server handles client disconnection from channels (related to join_channel functionality).
          channels.forEach((clients) => {
            clients.delete(ws);
          });
        }
      }
    });
    
    console.log(`WebSocket server running on port ${server.port}`);
  • WebSocket server handler for 'join' type messages, which implements the channel joining logic used by the MCP tool.
    if (data.type === "join") {
      const channelName = data.channel;
      if (!channelName || typeof channelName !== "string") {
        ws.send(JSON.stringify({
          type: "error",
          message: "Channel name is required"
        }));
        return;
      }
    
      // Create channel if it doesn't exist
      if (!channels.has(channelName)) {
        channels.set(channelName, new Set());
      }
    
      // Add client to channel
      const channelClients = channels.get(channelName)!;
      channelClients.add(ws);
    
      // Notify client they joined successfully
      ws.send(JSON.stringify({
        type: "system",
        message: `Joined channel: ${channelName}`,
        channel: channelName
      }));
    
      console.log("Sending message to client:", data.id);
    
      ws.send(JSON.stringify({
        type: "system",
        message: {
          id: data.id,
          result: "Connected to channel: " + channelName,
        },
        channel: channelName
      }));
    
      // Notify other clients in channel
      channelClients.forEach((client) => {
        if (client !== ws && client.readyState === WebSocket.OPEN) {
          client.send(JSON.stringify({
            type: "system",
            message: "A new user has joined the channel",
            channel: channelName
          }));
        }
      });
      return;
Behavior2/5

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

With no annotations, the description carries full burden but only states the basic action. It doesn't disclose behavioral traits such as required permissions, whether joining is reversible, rate limits, or what happens on success/failure. This is inadequate for a mutation tool with zero annotation coverage.

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 that directly states the tool's purpose without unnecessary words. It's appropriately sized and front-loaded, earning its place with zero waste.

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 this is a mutation tool with no annotations, no output schema, and incomplete behavioral disclosure, the description is insufficient. It lacks details on outcomes, error handling, or integration with sibling tools, making it incomplete for effective agent use.

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 the schema already documents the 'channel' parameter. The description adds no additional meaning beyond implying the channel is for Figma communication, which is minimal value. 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.

Purpose4/5

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

The description clearly states the action ('join') and resource ('a specific channel'), specifying it's for communication with Figma. However, it doesn't differentiate from sibling tools like 'create_connections' or 'set_default_connector' that might also involve channel/connection operations, keeping it from a perfect score.

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 explicit guidance on when to use this tool versus alternatives is provided. The description implies usage for channel-based communication but doesn't specify prerequisites, exclusions, or compare to siblings like 'create_connections', leaving the agent with minimal context for selection.

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/pipethedev/Talk-to-Figma-MCP'

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