figma-mcp-server 0.0.0-alpha.1 → 0.1.0

package/tools/figma/figma-api/get-actions-analytics.js

@@ -0,0 +1,67 @@
+/**
+ * Function to get actions analytics for a specific library file in Figma.
+ *
+ * @param {Object} args - Arguments for the request.
+ * @param {string} args.library_file_key - The key of the library file for which to retrieve actions analytics.
+ * @returns {Promise<Object>} - The actions analytics related to the library file.
+ */
+const executeFunction = async ({ library_file_key }) => {
+  const baseUrl = 'https://api.figma.com/v1';
+  const token = process.env.FIGMA_API_KEY;
+
+  try {
+    // Construct the URL for the request
+    const url = `${baseUrl}/analytics/libraries/${library_file_key}/actions`;
+
+    // Set up headers for the request
+    const headers = {
+      'X-Figma-Token': token
+    };
+
+    // Perform the fetch request
+    const response = await fetch(url, {
+      method: 'GET',
+      headers
+    });
+
+    // Check if the response was successful
+    if (!response.ok) {
+      const errorData = await response.json();
+      throw new Error(errorData);
+    }
+
+    // Parse and return the response data
+    const data = await response.json();
+    return data;
+  } catch (error) {
+    console.error('Error getting actions analytics:', error);
+    return { error: 'An error occurred while retrieving actions analytics.' };
+  }
+};
+
+/**
+ * Tool configuration for getting actions analytics for a library file in Figma.
+ * @type {Object}
+ */
+const apiTool = {
+  function: executeFunction,
+  definition: {
+    type: 'function',
+    function: {
+      name: 'get_actions_analytics',
+      description: 'Retrieve actions analytics for a specific library file in Figma.',
+      parameters: {
+        type: 'object',
+        properties: {
+          library_file_key: {
+            type: 'string',
+            description: 'The key of the library file for which to retrieve actions analytics.'
+          }
+        },
+        required: ['library_file_key']
+      }
+    }
+  }
+};
+
+export { apiTool };

package/tools/figma/figma-api/get-all-webhooks-for-team.js

@@ -0,0 +1,56 @@
+/**
+ * Function to get all webhooks for a team in Figma.
+ *
+ * @returns {Promise<Object>} - The result of the webhook retrieval.
+ */
+const executeFunction = async () => {
+  const webhookUrl = 'https://api.figma.com/v2/webhooks';
+  const token = process.env.FIGMA_API_KEY;
+  try {
+    // Set up headers for the request
+    const headers = {
+      'X-Figma-Token': token
+    };
+
+    // Perform the fetch request
+    const response = await fetch(webhookUrl, {
+      method: 'GET',
+      headers
+    });
+
+    // Check if the response was successful
+    if (!response.ok) {
+      const errorData = await response.text();
+      throw new Error(errorData);
+    }
+
+    // Parse and return the response data
+    const data = await response.json();
+    return data;
+  } catch (error) {
+    console.error('Error retrieving webhooks:', error);
+    return { error: 'An error occurred while retrieving webhooks.' };
+  }
+};
+
+/**
+ * Tool configuration for getting all webhooks for a team in Figma.
+ * @type {Object}
+ */
+const apiTool = {
+  function: executeFunction,
+  definition: {
+    type: 'function',
+    function: {
+      name: 'get_all_webhooks',
+      description: 'Retrieve all webhooks for a team in Figma.',
+      parameters: {
+        type: 'object',
+        properties: {},
+        required: []
+      }
+    }
+  }
+};
+
+export { apiTool };

package/tools/figma/figma-api/get-design-node.js

@@ -0,0 +1,72 @@
+/**
+ * Function to retrieve information about specific nodes in a Figma file.
+ *
+ * @param {Object} args - Arguments for the node retrieval.
+ * @param {string} args.file_key - The key of the Figma file.
+ * @param {string} args.node_id - The IDs of the nodes to retrieve, comma-separated.
+ * @returns {Promise<Object>} - The result of the node retrieval.
+ */
+const executeFunction = async ({ file_key, node_id }) => {
+  const baseUrl = 'https://api.figma.com/v1';
+  const token = process.env.FIGMA_API_KEY;
+
+  try {
+    // Construct the URL for the API request
+    const url = `${baseUrl}/files/${file_key}/nodes?ids=${node_id}`;
+
+    // Set up headers for the request
+    const headers = {
+      'X-Figma-Token': token
+    };
+
+    // Perform the fetch request
+    const response = await fetch(url, {
+      method: 'GET',
+      headers
+    });
+
+    // Check if the response was successful
+    if (!response.ok) {
+      const errorData = await response.json();
+      throw new Error(errorData);
+    }
+
+    // Parse and return the response data
+    const data = await response.json();
+    return data;
+  } catch (error) {
+    console.error('Error retrieving node information:', error);
+    return { error: 'An error occurred while retrieving node information.' };
+  }
+};
+
+/**
+ * Tool configuration for retrieving node information from a Figma file.
+ * @type {Object}
+ */
+const apiTool = {
+  function: executeFunction,
+  definition: {
+    type: 'function',
+    function: {
+      name: 'get_design_node',
+      description: 'Retrieve information about specific nodes in a Figma file.',
+      parameters: {
+        type: 'object',
+        properties: {
+          file_key: {
+            type: 'string',
+            description: 'The key of the Figma file.'
+          },
+          node_id: {
+            type: 'string',
+            description: 'The IDs of the nodes to retrieve, comma-separated.'
+          }
+        },
+        required: ['file_key', 'node_id']
+      }
+    }
+  }
+};
+
+export { apiTool };

package/tools/figma/figma-api/get-design.js

@@ -0,0 +1,66 @@
+/**
+ * Function to retrieve a Figma file by its unique file key.
+ *
+ * @param {Object} args - Arguments for the file retrieval.
+ * @param {string} args.file_key - The unique identifier of the Figma file.
+ * @returns {Promise<Object>} - The result of the file retrieval.
+ */
+const executeFunction = async ({ file_key }) => {
+  const baseUrl = 'https://api.figma.com/v1';
+  const token = process.env.FIGMA_API_KEY;
+  try {
+    // Construct the URL for the request
+    const url = `${baseUrl}/files/${file_key}`;
+
+    // Set up headers for the request
+    const headers = {
+      'X-Figma-Token': token
+    };
+
+    // Perform the fetch request
+    const response = await fetch(url, {
+      method: 'GET',
+      headers
+    });
+
+    // Check if the response was successful
+    if (!response.ok) {
+      const errorData = await response.json();
+      throw new Error(errorData.err || 'An error occurred while retrieving the file.');
+    }
+
+    // Parse and return the response data
+    const data = await response.json();
+    return data;
+  } catch (error) {
+    console.error('Error retrieving Figma file:', error);
+    return { error: 'An error occurred while retrieving the Figma file.' };
+  }
+};
+
+/**
+ * Tool configuration for retrieving a Figma file.
+ * @type {Object}
+ */
+const apiTool = {
+  function: executeFunction,
+  definition: {
+    type: 'function',
+    function: {
+      name: 'get_design',
+      description: 'Retrieve a Figma file by its unique file key.',
+      parameters: {
+        type: 'object',
+        properties: {
+          file_key: {
+            type: 'string',
+            description: 'The unique identifier of the Figma file.'
+          }
+        },
+        required: ['file_key']
+      }
+    }
+  }
+};
+
+export { apiTool };

package/tools/figma/figma-api/get-dev-resources.js

@@ -0,0 +1,67 @@
+/**
+ * Function to retrieve development resources for a specific Figma file.
+ *
+ * @param {Object} args - Arguments for the request.
+ * @param {string} args.file_key - The unique key of the Figma file.
+ * @returns {Promise<Object>} - The details of the development resources related to the specified file.
+ */
+const executeFunction = async ({ file_key }) => {
+  const baseUrl = 'https://api.figma.com/v1';
+  const token = process.env.FIGMA_API_KEY;
+
+  try {
+    // Construct the URL for the request
+    const url = `${baseUrl}/files/${file_key}/dev_resources`;
+
+    // Set up headers for the request
+    const headers = {
+      'X-Figma-Token': token
+    };
+
+    // Perform the fetch request
+    const response = await fetch(url, {
+      method: 'GET',
+      headers
+    });
+
+    // Check if the response was successful
+    if (!response.ok) {
+      const errorData = await response.json();
+      throw new Error(errorData);
+    }
+
+    // Parse and return the response data
+    const data = await response.json();
+    return data;
+  } catch (error) {
+    console.error('Error retrieving development resources:', error);
+    return { error: 'An error occurred while retrieving development resources.' };
+  }
+};
+
+/**
+ * Tool configuration for retrieving development resources from Figma.
+ * @type {Object}
+ */
+const apiTool = {
+  function: executeFunction,
+  definition: {
+    type: 'function',
+    function: {
+      name: 'get_dev_resources',
+      description: 'Retrieve development resources for a specific Figma file.',
+      parameters: {
+        type: 'object',
+        properties: {
+          file_key: {
+            type: 'string',
+            description: 'The unique key of the Figma file.'
+          }
+        },
+        required: ['file_key']
+      }
+    }
+  }
+};
+
+export { apiTool };

package/tools/figma/figma-api/get-file-comments.js

@@ -0,0 +1,67 @@
+/**
+ * Function to get comments for a specific Figma file.
+ *
+ * @param {Object} args - Arguments for the request.
+ * @param {string} args.file_key - The key of the Figma file to retrieve comments from.
+ * @returns {Promise<Object>} - The comments associated with the specified file.
+ */
+const executeFunction = async ({ file_key }) => {
+  const baseUrl = 'https://api.figma.com/v1';
+  const token = process.env.FIGMA_API_KEY;
+
+  try {
+    // Construct the URL for the request
+    const url = `${baseUrl}/files/${file_key}/comments`;
+
+    // Set up headers for the request
+    const headers = {
+      'X-Figma-Token': token
+    };
+
+    // Perform the fetch request
+    const response = await fetch(url, {
+      method: 'GET',
+      headers
+    });
+
+    // Check if the response was successful
+    if (!response.ok) {
+      const errorData = await response.json();
+      throw new Error(errorData);
+    }
+
+    // Parse and return the response data
+    const data = await response.json();
+    return data;
+  } catch (error) {
+    console.error('Error getting file comments:', error);
+    return { error: 'An error occurred while retrieving file comments.' };
+  }
+};
+
+/**
+ * Tool configuration for getting comments from a Figma file.
+ * @type {Object}
+ */
+const apiTool = {
+  function: executeFunction,
+  definition: {
+    type: 'function',
+    function: {
+      name: 'get_file_comments',
+      description: 'Retrieve comments associated with a specific Figma file.',
+      parameters: {
+        type: 'object',
+        properties: {
+          file_key: {
+            type: 'string',
+            description: 'The key of the Figma file to retrieve comments from.'
+          }
+        },
+        required: ['file_key']
+      }
+    }
+  }
+};
+
+export { apiTool };

package/tools/figma/figma-api/get-image-node.js

@@ -0,0 +1,74 @@
+/**
+ * Function to retrieve images from Figma using a specific file key and optional image IDs.
+ *
+ * @param {Object} args - Arguments for the image retrieval.
+ * @param {string} args.file_key - The key of the Figma file.
+ * @param {string} [args.ids] - A comma-separated list of specific image IDs to fetch.
+ * @returns {Promise<Object>} - The result of the image retrieval.
+ */
+const executeFunction = async ({ file_key, ids }) => {
+  const baseUrl = 'https://api.figma.com/v1';
+  const token = process.env.FIGMA_API_KEY;
+  try {
+    // Construct the URL with the file key and optional image IDs
+    const url = new URL(`${baseUrl}/images/${file_key}`);
+    if (ids) {
+      url.searchParams.append('ids', ids);
+    }
+
+    // Set up headers for the request
+    const headers = {
+      'X-Figma-Token': token
+    };
+
+    // Perform the fetch request
+    const response = await fetch(url.toString(), {
+      method: 'GET',
+      headers
+    });
+
+    // Check if the response was successful
+    if (!response.ok) {
+      const errorData = await response.json();
+      throw new Error(errorData);
+    }
+
+    // Parse and return the response data
+    const data = await response.json();
+    return data;
+  } catch (error) {
+    console.error('Error retrieving images from Figma:', error);
+    return { error: 'An error occurred while retrieving images from Figma.' };
+  }
+};
+
+/**
+ * Tool configuration for retrieving images from Figma.
+ * @type {Object}
+ */
+const apiTool = {
+  function: executeFunction,
+  definition: {
+    type: 'function',
+    function: {
+      name: 'get_image_node',
+      description: 'Retrieve images from Figma using a specific file key and optional image IDs.',
+      parameters: {
+        type: 'object',
+        properties: {
+          file_key: {
+            type: 'string',
+            description: 'The key of the Figma file.'
+          },
+          ids: {
+            type: 'string',
+            description: 'A comma-separated list of specific image IDs to fetch.'
+          }
+        },
+        required: ['file_key']
+      }
+    }
+  }
+};
+
+export { apiTool };

package/tools/figma/figma-api/get-images.js

@@ -0,0 +1,66 @@
+/**
+ * Function to retrieve images associated with a Figma file.
+ *
+ * @param {Object} args - Arguments for the image retrieval.
+ * @param {string} args.file_key - The Figma file key representing the specific Figma file from which images are to be retrieved.
+ * @returns {Promise<Object>} - The result of the image retrieval.
+ */
+const executeFunction = async ({ file_key }) => {
+  const baseUrl = 'https://api.figma.com/v1';
+  const token = process.env.FIGMA_API_KEY;
+  try {
+    // Construct the URL for the image retrieval
+    const url = `${baseUrl}/files/${file_key}/images`;
+
+    // Set up headers for the request
+    const headers = {
+      'X-Figma-Token': token
+    };
+
+    // Perform the fetch request
+    const response = await fetch(url, {
+      method: 'GET',
+      headers
+    });
+
+    // Check if the response was successful
+    if (!response.ok) {
+      const errorData = await response.json();
+      throw new Error(errorData);
+    }
+
+    // Parse and return the response data
+    const data = await response.json();
+    return data;
+  } catch (error) {
+    console.error('Error retrieving images:', error);
+    return { error: 'An error occurred while retrieving images.' };
+  }
+};
+
+/**
+ * Tool configuration for retrieving images from Figma.
+ * @type {Object}
+ */
+const apiTool = {
+  function: executeFunction,
+  definition: {
+    type: 'function',
+    function: {
+      name: 'get_images',
+      description: 'Retrieve images associated with a Figma file.',
+      parameters: {
+        type: 'object',
+        properties: {
+          file_key: {
+            type: 'string',
+            description: 'The Figma file key representing the specific Figma file from which images are to be retrieved.'
+          }
+        },
+        required: ['file_key']
+      }
+    }
+  }
+};
+
+export { apiTool };

package/tools/figma/figma-api/get-library-analytics.js

@@ -0,0 +1,66 @@
+/**
+ * Function to get library analytics from Figma.
+ *
+ * @param {Object} args - Arguments for the library analytics request.
+ * @param {string} args.library_file_key - The unique identifier of the library file.
+ * @returns {Promise<Object>} - The result of the library analytics request.
+ */
+const executeFunction = async ({ library_file_key }) => {
+  const baseUrl = 'https://api.figma.com/v1';
+  const token = process.env.FIGMA_API_KEY;
+  try {
+    // Construct the URL for the request
+    const url = `${baseUrl}/analytics/libraries/${library_file_key}/usages`;
+
+    // Set up headers for the request
+    const headers = {
+      'X-Figma-Token': token
+    };
+
+    // Perform the fetch request
+    const response = await fetch(url, {
+      method: 'GET',
+      headers
+    });
+
+    // Check if the response was successful
+    if (!response.ok) {
+      const errorData = await response.json();
+      throw new Error(errorData);
+    }
+
+    // Parse and return the response data
+    const data = await response.json();
+    return data;
+  } catch (error) {
+    console.error('Error getting library analytics:', error);
+    return { error: 'An error occurred while retrieving library analytics.' };
+  }
+};
+
+/**
+ * Tool configuration for getting library analytics from Figma.
+ * @type {Object}
+ */
+const apiTool = {
+  function: executeFunction,
+  definition: {
+    type: 'function',
+    function: {
+      name: 'get_library_analytics',
+      description: 'Retrieve library analytics from Figma.',
+      parameters: {
+        type: 'object',
+        properties: {
+          library_file_key: {
+            type: 'string',
+            description: 'The unique identifier of the library file.'
+          }
+        },
+        required: ['library_file_key']
+      }
+    }
+  }
+};
+
+export { apiTool };

package/tools/figma/figma-api/get-project-files.js

@@ -0,0 +1,66 @@
+/**
+ * Function to get project files from Figma.
+ *
+ * @param {Object} args - Arguments for the request.
+ * @param {string} args.project_id - The ID of the project to retrieve files from.
+ * @returns {Promise<Object>} - The list of files associated with the specified project.
+ */
+const executeFunction = async ({ project_id }) => {
+  const baseUrl = 'https://api.figma.com/v1';
+  const token = process.env.FIGMA_API_KEY;
+  try {
+    // Construct the URL for the request
+    const url = `${baseUrl}/projects/${project_id}/files`;
+
+    // Set up headers for the request
+    const headers = {
+      'X-Figma-Token': token
+    };
+
+    // Perform the fetch request
+    const response = await fetch(url, {
+      method: 'GET',
+      headers
+    });
+
+    // Check if the response was successful
+    if (!response.ok) {
+      const errorData = await response.json();
+      throw new Error(errorData);
+    }
+
+    // Parse and return the response data
+    const data = await response.json();
+    return data;
+  } catch (error) {
+    console.error('Error retrieving project files:', error);
+    return { error: 'An error occurred while retrieving project files.' };
+  }
+};
+
+/**
+ * Tool configuration for getting project files from Figma.
+ * @type {Object}
+ */
+const apiTool = {
+  function: executeFunction,
+  definition: {
+    type: 'function',
+    function: {
+      name: 'get_project_files',
+      description: 'Retrieve files associated with a specific project in Figma.',
+      parameters: {
+        type: 'object',
+        properties: {
+          project_id: {
+            type: 'string',
+            description: 'The ID of the project to retrieve files from.'
+          }
+        },
+        required: ['project_id']
+      }
+    }
+  }
+};
+
+export { apiTool };