figma-mcp-server 0.1.0 → 0.1.2

package/tools/figma/figma-api/get-a-published-component-set-by-key.js

@@ -0,0 +1,66 @@
+/**
+ * Function to get metadata for a published component set by its key from Figma.
+ *
+ * @param {Object} args - Arguments for the request.
+ * @param {string} args.key - The key of the component set to retrieve.
+ * @returns {Promise<Object>} - The metadata for the component set.
+ */
+const executeFunction = async ({ key }) => {
+  const baseUrl = 'https://api.figma.com';
+  const token = process.env.FIGMA_API_KEY;
+  try {
+    // Construct the URL with the component set key
+    const url = `${baseUrl}/v1/component_sets/${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);
+    }
+
+    // Parse and return the response data
+    const data = await response.json();
+    return data;
+  } catch (error) {
+    console.error('Error retrieving component set metadata:', error);
+    return { error: 'An error occurred while retrieving component set metadata.' };
+  }
+};
+
+/**
+ * Tool configuration for retrieving component set metadata from Figma.
+ * @type {Object}
+ */
+const apiTool = {
+  function: executeFunction,
+  definition: {
+    type: 'function',
+    function: {
+      name: 'get_component_set',
+      description: 'Retrieve metadata for a published component set by its key.',
+      parameters: {
+        type: 'object',
+        properties: {
+          key: {
+            type: 'string',
+            description: 'The key of the component set to retrieve.'
+          }
+        },
+        required: ['key']
+      }
+    }
+  }
+};
+
+export { apiTool };

package/tools/figma/figma-api/get-a-published-library-by-id.js

@@ -0,0 +1,66 @@
+/**
+ * Function to get metadata for a published library in Figma by its ID.
+ *
+ * @param {Object} args - Arguments for the library retrieval.
+ * @param {string} args.library_id - The ID of the library to retrieve.
+ * @returns {Promise<Object>} - The metadata of the published library.
+ */
+const executeFunction = async ({ library_id }) => {
+  const baseUrl = 'https://api.figma.com';
+  const token = process.env.FIGMA_API_KEY;
+  try {
+    // Construct the URL with the library ID
+    const url = `${baseUrl}/v1/libraries/${library_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 library metadata:', error);
+    return { error: 'An error occurred while retrieving library metadata.' };
+  }
+};
+
+/**
+ * Tool configuration for retrieving library metadata in Figma.
+ * @type {Object}
+ */
+const apiTool = {
+  function: executeFunction,
+  definition: {
+    type: 'function',
+    function: {
+      name: 'get_library_by_id',
+      description: 'Retrieve metadata for a published library by its ID.',
+      parameters: {
+        type: 'object',
+        properties: {
+          library_id: {
+            type: 'string',
+            description: 'The ID of the library to retrieve.'
+          }
+        },
+        required: ['library_id']
+      }
+    }
+  }
+};
+
+export { apiTool };

package/tools/figma/figma-api/get-a-published-style-by-key.js

@@ -0,0 +1,66 @@
+/**
+ * Function to get a published style from Figma by its key.
+ *
+ * @param {Object} args - Arguments for the request.
+ * @param {string} args.key - The key of the published style to retrieve.
+ * @returns {Promise<Object>} - The metadata for the published style.
+ */
+const executeFunction = async ({ key }) => {
+  const baseUrl = 'https://api.figma.com';
+  const token = process.env.FIGMA_API_KEY;
+  try {
+    // Construct the URL with the style key
+    const url = `${baseUrl}/v1/styles/${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);
+    }
+
+    // Parse and return the response data
+    const data = await response.json();
+    return data;
+  } catch (error) {
+    console.error('Error retrieving published style:', error);
+    return { error: 'An error occurred while retrieving the published style.' };
+  }
+};
+
+/**
+ * Tool configuration for getting a published style from Figma.
+ * @type {Object}
+ */
+const apiTool = {
+  function: executeFunction,
+  definition: {
+    type: 'function',
+    function: {
+      name: 'get_published_style',
+      description: 'Retrieve metadata for a published style by its key.',
+      parameters: {
+        type: 'object',
+        properties: {
+          key: {
+            type: 'string',
+            description: 'The key of the published style to retrieve.'
+          }
+        },
+        required: ['key']
+      }
+    }
+  }
+};
+
+export { apiTool };

package/tools/figma/figma-api/{get-all-webhooks-for-team.js → get-current-user.js}

@@ -1,10 +1,10 @@
 /**
- * Function to get all webhooks for a team in Figma.
+ * Function to get the current user information from Figma.
  *
- * @returns {Promise<Object>} - The result of the webhook retrieval.
+ * @returns {Promise<Object>} - The information about the user associated with the access token.
  */
 const executeFunction = async () => {
-  const webhookUrl = 'https://api.figma.com/v2/webhooks';
+  const baseUrl = 'https://api.figma.com';
   const token = process.env.FIGMA_API_KEY;
   try {
     // Set up headers for the request
@@ -13,14 +13,14 @@ const executeFunction = async () => {
     };
 
     // Perform the fetch request
-    const response = await fetch(webhookUrl, {
+    const response = await fetch(`${baseUrl}/v1/me`, {
       method: 'GET',
       headers
     });
 
     // Check if the response was successful
     if (!response.ok) {
-      const errorData = await response.text();
+      const errorData = await response.json();
       throw new Error(errorData);
     }
 
@@ -28,13 +28,13 @@ const executeFunction = async () => {
     const data = await response.json();
     return data;
   } catch (error) {
-    console.error('Error retrieving webhooks:', error);
-    return { error: 'An error occurred while retrieving webhooks.' };
+    console.error('Error getting current user information:', error);
+    return { error: 'An error occurred while getting user information.' };
   }
 };
 
 /**
- * Tool configuration for getting all webhooks for a team in Figma.
+ * Tool configuration for getting the current user information from Figma.
  * @type {Object}
  */
 const apiTool = {
@@ -42,8 +42,8 @@ const apiTool = {
   definition: {
     type: 'function',
     function: {
-      name: 'get_all_webhooks',
-      description: 'Retrieve all webhooks for a team in Figma.',
+      name: 'get_current_user',
+      description: 'Get the current user information from Figma.',
       parameters: {
         type: 'object',
         properties: {},

package/tools/figma/figma-api/{get-design-node.js → get-file-nodes.js}

@@ -1,18 +1,20 @@
 /**
- * Function to retrieve information about specific nodes in a Figma file.
+ * Function to get specific nodes from a Figma file.
  *
- * @param {Object} args - Arguments for the node retrieval.
+ * @param {Object} args - Arguments for the request.
  * @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.
+ * @param {string} [args.node_id] - The ID of the node to retrieve. If not provided, all nodes will be returned.
  * @returns {Promise<Object>} - The result of the node retrieval.
  */
 const executeFunction = async ({ file_key, node_id }) => {
-  const baseUrl = 'https://api.figma.com/v1';
+  const baseUrl = 'https://api.figma.com';
   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}`;
+    // Construct the URL
+    const url = new URL(`${baseUrl}/v1/files/${file_key}/nodes`);
+    if (node_id) {
+      url.searchParams.append('ids', node_id);
+    }
 
     // Set up headers for the request
     const headers = {
@@ -20,7 +22,7 @@ const executeFunction = async ({ file_key, node_id }) => {
     };
 
     // Perform the fetch request
-    const response = await fetch(url, {
+    const response = await fetch(url.toString(), {
       method: 'GET',
       headers
     });
@@ -35,13 +37,13 @@ const executeFunction = async ({ file_key, node_id }) => {
     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.' };
+    console.error('Error getting file nodes:', error);
+    return { error: 'An error occurred while retrieving file nodes.' };
   }
 };
 
 /**
- * Tool configuration for retrieving node information from a Figma file.
+ * Tool configuration for getting nodes from a Figma file.
  * @type {Object}
  */
 const apiTool = {
@@ -49,8 +51,8 @@ const apiTool = {
   definition: {
     type: 'function',
     function: {
-      name: 'get_design_node',
-      description: 'Retrieve information about specific nodes in a Figma file.',
+      name: 'get_file_nodes',
+      description: 'Retrieve specific nodes from a Figma file.',
       parameters: {
         type: 'object',
         properties: {
@@ -60,10 +62,10 @@ const apiTool = {
           },
           node_id: {
             type: 'string',
-            description: 'The IDs of the nodes to retrieve, comma-separated.'
+            description: 'The ID of the node to retrieve.'
           }
         },
-        required: ['file_key', 'node_id']
+        required: ['file_key']
       }
     }
   }

package/tools/figma/figma-api/get-file-version-history.js

@@ -0,0 +1,66 @@
+/**
+ * Function to get the version history of a Figma file.
+ *
+ * @param {Object} args - Arguments for the request.
+ * @param {string} args.file_key - The key of the Figma file for which to retrieve version history.
+ * @returns {Promise<Object>} - The version history of the specified Figma file.
+ */
+const executeFunction = async ({ file_key }) => {
+  const baseUrl = 'https://api.figma.com';
+  const token = process.env.FIGMA_API_KEY;
+  try {
+    // Construct the URL for the request
+    const url = `${baseUrl}/v1/files/${file_key}/versions`;
+
+    // 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 file version history:', error);
+    return { error: 'An error occurred while retrieving the file version history.' };
+  }
+};
+
+/**
+ * Tool configuration for retrieving the version history of a Figma file.
+ * @type {Object}
+ */
+const apiTool = {
+  function: executeFunction,
+  definition: {
+    type: 'function',
+    function: {
+      name: 'get_file_version_history',
+      description: 'Retrieve the version history of a specified Figma file.',
+      parameters: {
+        type: 'object',
+        properties: {
+          file_key: {
+            type: 'string',
+            description: 'The key of the Figma file for which to retrieve version history.'
+          }
+        },
+        required: ['file_key']
+      }
+    }
+  }
+};
+
+export { apiTool };

package/tools/figma/figma-api/{get-design.js → get-file.js}

@@ -1,16 +1,16 @@
 /**
- * Function to retrieve a Figma file by its unique file key.
+ * Function to get the full document tree of a Figma file.
  *
  * @param {Object} args - Arguments for the file retrieval.
- * @param {string} args.file_key - The unique identifier of the Figma file.
+ * @param {string} args.file_key - The key of the Figma file to retrieve.
  * @returns {Promise<Object>} - The result of the file retrieval.
  */
 const executeFunction = async ({ file_key }) => {
-  const baseUrl = 'https://api.figma.com/v1';
+  const baseUrl = 'https://api.figma.com';
   const token = process.env.FIGMA_API_KEY;
   try {
     // Construct the URL for the request
-    const url = `${baseUrl}/files/${file_key}`;
+    const url = `${baseUrl}/v1/files/${file_key}`;
 
     // Set up headers for the request
     const headers = {
@@ -26,7 +26,7 @@ const executeFunction = async ({ file_key }) => {
     // 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.');
+      throw new Error(errorData);
     }
 
     // Parse and return the response data
@@ -47,14 +47,14 @@ const apiTool = {
   definition: {
     type: 'function',
     function: {
-      name: 'get_design',
-      description: 'Retrieve a Figma file by its unique file key.',
+      name: 'get_figma_file',
+      description: 'Retrieve the full document tree of a Figma file.',
       parameters: {
         type: 'object',
         properties: {
           file_key: {
             type: 'string',
-            description: 'The unique identifier of the Figma file.'
+            description: 'The key of the Figma file to retrieve.'
           }
         },
         required: ['file_key']

package/tools/figma/figma-api/{get-image-node.js → get-image-fills.js}

@@ -1,19 +1,19 @@
 /**
- * Function to retrieve images from Figma using a specific file key and optional image IDs.
+ * Function to get image fills from a Figma file.
  *
- * @param {Object} args - Arguments for the image retrieval.
+ * @param {Object} args - Arguments for the image fills request.
  * @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.
+ * @param {string} [args.node_id] - The ID of the specific node to retrieve images for (optional).
+ * @returns {Promise<Object>} - The URLs for rendered images of specific nodes.
  */
-const executeFunction = async ({ file_key, ids }) => {
-  const baseUrl = 'https://api.figma.com/v1';
+const executeFunction = async ({ file_key, node_id }) => {
+  const baseUrl = 'https://api.figma.com';
   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);
+    // Construct the URL with the file key and optional node ID
+    const url = new URL(`${baseUrl}/v1/images/${file_key}`);
+    if (node_id) {
+      url.searchParams.append('ids', node_id);
     }
 
     // Set up headers for the request
@@ -37,13 +37,13 @@ const executeFunction = async ({ file_key, ids }) => {
     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.' };
+    console.error('Error getting image fills:', error);
+    return { error: 'An error occurred while getting image fills.' };
   }
 };
 
 /**
- * Tool configuration for retrieving images from Figma.
+ * Tool configuration for getting image fills from a Figma file.
  * @type {Object}
  */
 const apiTool = {
@@ -51,8 +51,8 @@ const apiTool = {
   definition: {
     type: 'function',
     function: {
-      name: 'get_image_node',
-      description: 'Retrieve images from Figma using a specific file key and optional image IDs.',
+      name: 'get_image_fills',
+      description: 'Get image fills from a Figma file.',
       parameters: {
         type: 'object',
         properties: {
@@ -60,9 +60,9 @@ const apiTool = {
             type: 'string',
             description: 'The key of the Figma file.'
           },
-          ids: {
+          node_id: {
             type: 'string',
-            description: 'A comma-separated list of specific image IDs to fetch.'
+            description: 'The ID of the specific node to retrieve images for.'
           }
         },
         required: ['file_key']

package/tools/figma/figma-api/{get-library-analytics.js → get-library-action-analytics.js}

@@ -1,16 +1,16 @@
 /**
- * Function to get library analytics from Figma.
+ * Function to get library action 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.
+ * @param {Object} args - Arguments for the analytics request.
+ * @param {string} args.library_file_key - The key of the library file for which to retrieve action analytics.
+ * @returns {Promise<Object>} - The result of the library action analytics request.
  */
 const executeFunction = async ({ library_file_key }) => {
-  const baseUrl = 'https://api.figma.com/v1';
+  const baseUrl = 'https://api.figma.com';
   const token = process.env.FIGMA_API_KEY;
   try {
     // Construct the URL for the request
-    const url = `${baseUrl}/analytics/libraries/${library_file_key}/usages`;
+    const url = `${baseUrl}/v1/analytics/libraries/${library_file_key}/actions`;
 
     // Set up headers for the request
     const headers = {
@@ -33,13 +33,13 @@ const executeFunction = async ({ library_file_key }) => {
     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.' };
+    console.error('Error retrieving library action analytics:', error);
+    return { error: 'An error occurred while retrieving library action analytics.' };
   }
 };
 
 /**
- * Tool configuration for getting library analytics from Figma.
+ * Tool configuration for getting library action analytics from Figma.
  * @type {Object}
  */
 const apiTool = {
@@ -47,14 +47,14 @@ const apiTool = {
   definition: {
     type: 'function',
     function: {
-      name: 'get_library_analytics',
-      description: 'Retrieve library analytics from Figma.',
+      name: 'get_library_action_analytics',
+      description: 'Retrieve action analytics for a specific published library file.',
       parameters: {
         type: 'object',
         properties: {
           library_file_key: {
             type: 'string',
-            description: 'The unique identifier of the library file.'
+            description: 'The key of the library file for which to retrieve action analytics.'
           }
         },
         required: ['library_file_key']

package/tools/figma/figma-api/{get-actions-analytics.js → get-library-usage-analytics.js}

@@ -1,17 +1,16 @@
 /**
- * Function to get actions analytics for a specific library file in Figma.
+ * Function to get library usage analytics from 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.
+ * @param {Object} args - Arguments for the analytics request.
+ * @param {string} args.library_file_key - The key of the library file for which to retrieve usage analytics.
+ * @returns {Promise<Object>} - The result of the library usage analytics request.
  */
 const executeFunction = async ({ library_file_key }) => {
-  const baseUrl = 'https://api.figma.com/v1';
+  const baseUrl = 'https://api.figma.com';
   const token = process.env.FIGMA_API_KEY;
-
   try {
     // Construct the URL for the request
-    const url = `${baseUrl}/analytics/libraries/${library_file_key}/actions`;
+    const url = `${baseUrl}/v1/analytics/libraries/${library_file_key}/usages`;
 
     // Set up headers for the request
     const headers = {
@@ -34,13 +33,13 @@ const executeFunction = async ({ library_file_key }) => {
     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.' };
+    console.error('Error retrieving library usage analytics:', error);
+    return { error: 'An error occurred while retrieving library usage analytics.' };
   }
 };
 
 /**
- * Tool configuration for getting actions analytics for a library file in Figma.
+ * Tool configuration for getting library usage analytics from Figma.
  * @type {Object}
  */
 const apiTool = {
@@ -48,14 +47,14 @@ const apiTool = {
   definition: {
     type: 'function',
     function: {
-      name: 'get_actions_analytics',
-      description: 'Retrieve actions analytics for a specific library file in Figma.',
+      name: 'get_library_usage_analytics',
+      description: 'Retrieve usage analytics for a specific published library file.',
       parameters: {
         type: 'object',
         properties: {
           library_file_key: {
             type: 'string',
-            description: 'The key of the library file for which to retrieve actions analytics.'
+            description: 'The key of the library file for which to retrieve usage analytics.'
           }
         },
         required: ['library_file_key']