figma-mcp-server 0.1.0 → 0.1.2

package/tools/figma/figma-api/list-comments-on-a-file.js

@@ -0,0 +1,66 @@
+/**
+ * Function to list comments on a Figma file.
+ *
+ * @param {Object} args - Arguments for the comment listing.
+ * @param {string} args.file_key - The key of the Figma file to list comments from.
+ * @returns {Promise<Array>} - A promise that resolves to an array of comments.
+ */
+const executeFunction = async ({ file_key }) => {
+  const baseUrl = 'https://api.figma.com';
+  const token = process.env.FIGMA_API_KEY;
+  try {
+    // Construct the URL for the API request
+    const url = `${baseUrl}/v1/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.comments || [];
+  } catch (error) {
+    console.error('Error listing comments on the Figma file:', error);
+    return { error: 'An error occurred while listing comments.' };
+  }
+};
+
+/**
+ * Tool configuration for listing comments on a Figma file.
+ * @type {Object}
+ */
+const apiTool = {
+  function: executeFunction,
+  definition: {
+    type: 'function',
+    function: {
+      name: 'list_comments',
+      description: 'List comments on a Figma file.',
+      parameters: {
+        type: 'object',
+        properties: {
+          file_key: {
+            type: 'string',
+            description: 'The key of the Figma file to list comments from.'
+          }
+        },
+        required: ['file_key']
+      }
+    }
+  }
+};
+
+export { apiTool };

package/tools/figma/figma-api/{get-dev-resources.js → list-component-sets-in-a-file.js}

@@ -1,17 +1,17 @@
 /**
- * Function to retrieve development resources for a specific Figma file.
+ * Function to list component sets in 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.
+ * @param {string} args.file_key - The key of the Figma file to retrieve component sets from.
+ * @returns {Promise<Object>} - The response containing the list of component sets.
  */
 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}/dev_resources`;
+    const url = `${baseUrl}/v1/files/${file_key}/component_sets`;
 
     // Set up headers for the request
     const headers = {
@@ -34,13 +34,13 @@ const executeFunction = async ({ file_key }) => {
     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.' };
+    console.error('Error listing component sets:', error);
+    return { error: 'An error occurred while listing component sets.' };
   }
 };
 
 /**
- * Tool configuration for retrieving development resources from Figma.
+ * Tool configuration for listing component sets in a Figma file.
  * @type {Object}
  */
 const apiTool = {
@@ -48,14 +48,14 @@ const apiTool = {
   definition: {
     type: 'function',
     function: {
-      name: 'get_dev_resources',
-      description: 'Retrieve development resources for a specific Figma file.',
+      name: 'list_component_sets',
+      description: 'List all component sets published in a specific Figma file.',
       parameters: {
         type: 'object',
         properties: {
           file_key: {
             type: 'string',
-            description: 'The unique key of the Figma file.'
+            description: 'The key of the Figma file to retrieve component sets from.'
           }
         },
         required: ['file_key']

package/tools/figma/figma-api/list-components-in-a-file.js

@@ -0,0 +1,66 @@
+/**
+ * Function to list components in a specific Figma file.
+ *
+ * @param {Object} args - Arguments for the request.
+ * @param {string} args.file_key - The key of the Figma file to retrieve components from.
+ * @returns {Promise<Object>} - The list of components in 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}/components`;
+
+    // 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 listing components in file:', error);
+    return { error: 'An error occurred while listing components in the file.' };
+  }
+};
+
+/**
+ * Tool configuration for listing components in a Figma file.
+ * @type {Object}
+ */
+const apiTool = {
+  function: executeFunction,
+  definition: {
+    type: 'function',
+    function: {
+      name: 'list_components',
+      description: 'List components in a specific Figma file.',
+      parameters: {
+        type: 'object',
+        properties: {
+          file_key: {
+            type: 'string',
+            description: 'The key of the Figma file to retrieve components from.'
+          }
+        },
+        required: ['file_key']
+      }
+    }
+  }
+};
+
+export { apiTool };

package/tools/figma/figma-api/list-dev-resources-for-a-file.js

@@ -0,0 +1,66 @@
+/**
+ * Function to list development resources 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 development resources for.
+ * @returns {Promise<Object>} - The result of the development resources request.
+ */
+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}/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 listing development resources:', error);
+    return { error: 'An error occurred while listing development resources.' };
+  }
+};
+
+/**
+ * Tool configuration for listing development resources for a Figma file.
+ * @type {Object}
+ */
+const apiTool = {
+  function: executeFunction,
+  definition: {
+    type: 'function',
+    function: {
+      name: 'list_dev_resources',
+      description: 'List development resources for a specific Figma file.',
+      parameters: {
+        type: 'object',
+        properties: {
+          file_key: {
+            type: 'string',
+            description: 'The key of the Figma file to retrieve development resources for.'
+          }
+        },
+        required: ['file_key']
+      }
+    }
+  }
+};
+
+export { apiTool };

package/tools/figma/figma-api/{get-project-files.js → list-files-in-a-project.js}

@@ -1,16 +1,17 @@
 /**
- * Function to get project files from Figma.
+ * Function to list files in a specified Figma project.
  *
  * @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.
+ * @param {string} args.project_id - The ID of the project to list files from.
+ * @returns {Promise<Object>} - The result of the files listing.
  */
 const executeFunction = async ({ project_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 request
-    const url = `${baseUrl}/projects/${project_id}/files`;
+    const url = `${baseUrl}/v1/projects/${project_id}/files`;
 
     // Set up headers for the request
     const headers = {
@@ -33,13 +34,13 @@ const executeFunction = async ({ project_id }) => {
     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.' };
+    console.error('Error listing files in project:', error);
+    return { error: 'An error occurred while listing files in the project.' };
   }
 };
 
 /**
- * Tool configuration for getting project files from Figma.
+ * Tool configuration for listing files in a Figma project.
  * @type {Object}
  */
 const apiTool = {
@@ -47,14 +48,14 @@ const apiTool = {
   definition: {
     type: 'function',
     function: {
-      name: 'get_project_files',
-      description: 'Retrieve files associated with a specific project in Figma.',
+      name: 'list_files_in_project',
+      description: 'List files in a specified Figma project.',
       parameters: {
         type: 'object',
         properties: {
           project_id: {
             type: 'string',
-            description: 'The ID of the project to retrieve files from.'
+            description: 'The ID of the project to list files from.'
           }
         },
         required: ['project_id']

package/tools/figma/figma-api/{get-team-projects.js → list-projects-in-a-team.js}

@@ -1,16 +1,16 @@
 /**
- * Function to get projects associated with a specific team in Figma.
+ * Function to list projects in a specified team on Figma.
  *
  * @param {Object} args - Arguments for the request.
- * @param {string} args.team_id - The ID of the team whose projects are to be retrieved.
- * @returns {Promise<Object>} - The list of projects associated with the team.
+ * @param {string} args.team_id - The ID of the team for which to list projects.
+ * @returns {Promise<Object>} - The list of projects within the specified team.
  */
 const executeFunction = async ({ team_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 request
-    const url = `${baseUrl}/teams/${team_id}/projects`;
+    const url = `${baseUrl}/v1/teams/${team_id}/projects`;
 
     // Set up headers for the request
     const headers = {
@@ -33,13 +33,13 @@ const executeFunction = async ({ team_id }) => {
     const data = await response.json();
     return data;
   } catch (error) {
-    console.error('Error retrieving team projects:', error);
-    return { error: 'An error occurred while retrieving team projects.' };
+    console.error('Error listing projects:', error);
+    return { error: 'An error occurred while listing projects.' };
   }
 };
 
 /**
- * Tool configuration for getting team projects in Figma.
+ * Tool configuration for listing projects in a team on Figma.
  * @type {Object}
  */
 const apiTool = {
@@ -47,14 +47,14 @@ const apiTool = {
   definition: {
     type: 'function',
     function: {
-      name: 'get_team_projects',
-      description: 'Retrieve projects associated with a specific team in Figma.',
+      name: 'list_projects_in_team',
+      description: 'List all projects within a specified team on Figma.',
       parameters: {
         type: 'object',
         properties: {
           team_id: {
             type: 'string',
-            description: 'The ID of the team whose projects are to be retrieved.'
+            description: 'The ID of the team for which to list projects.'
           }
         },
         required: ['team_id']

package/tools/figma/figma-api/{add-webhook.js → list-published-libraries.js}

@@ -1,21 +1,20 @@
 /**
- * Function to add a webhook in Figma.
+ * Function to list published libraries in Figma.
  *
- * @returns {Promise<Object>} - The result of the webhook addition.
+ * @returns {Promise<Array>} - A promise that resolves to an array of published libraries.
  */
 const executeFunction = async () => {
-  const webhookUrl = 'https://api.figma.com/v2/webhooks';
+  const baseUrl = 'https://api.figma.com/v1/libraries/published';
   const token = process.env.FIGMA_API_KEY;
   try {
     // Set up headers for the request
     const headers = {
-      'X-Figma-Token': token,
-      'Content-Type': 'application/json'
+      'X-Figma-Token': token
     };
 
     // Perform the fetch request
-    const response = await fetch(webhookUrl, {
-      method: 'POST',
+    const response = await fetch(baseUrl, {
+      method: 'GET',
       headers
     });
 
@@ -29,13 +28,13 @@ const executeFunction = async () => {
     const data = await response.json();
     return data;
   } catch (error) {
-    console.error('Error adding webhook:', error);
-    return { error: 'An error occurred while adding the webhook.' };
+    console.error('Error listing published libraries:', error);
+    return { error: 'An error occurred while listing published libraries.' };
   }
 };
 
 /**
- * Tool configuration for adding a webhook in Figma.
+ * Tool configuration for listing published libraries in Figma.
  * @type {Object}
  */
 const apiTool = {
@@ -43,8 +42,8 @@ const apiTool = {
   definition: {
     type: 'function',
     function: {
-      name: 'add_webhook',
-      description: 'Add a webhook in Figma.',
+      name: 'list_published_libraries',
+      description: 'Returns all published libraries available to the authenticated user.',
       parameters: {
         type: 'object',
         properties: {},

package/tools/figma/figma-api/{get-file-comments.js → list-styles-in-a-file.js}

@@ -1,17 +1,17 @@
 /**
- * Function to get comments for a specific Figma file.
+ * Function to list styles in 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.
+ * @param {string} args.file_key - The key of the Figma file to retrieve styles from.
+ * @returns {Promise<Object>} - The response containing styles from the specified Figma file.
  */
 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}/comments`;
+    const url = `${baseUrl}/v1/files/${file_key}/styles`;
 
     // Set up headers for the request
     const headers = {
@@ -34,13 +34,13 @@ const executeFunction = async ({ file_key }) => {
     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.' };
+    console.error('Error listing styles in the Figma file:', error);
+    return { error: 'An error occurred while listing styles in the Figma file.' };
   }
 };
 
 /**
- * Tool configuration for getting comments from a Figma file.
+ * Tool configuration for listing styles in a Figma file.
  * @type {Object}
  */
 const apiTool = {
@@ -48,14 +48,14 @@ const apiTool = {
   definition: {
     type: 'function',
     function: {
-      name: 'get_file_comments',
-      description: 'Retrieve comments associated with a specific Figma file.',
+      name: 'list_styles_in_file',
+      description: 'List styles in a specific Figma file.',
       parameters: {
         type: 'object',
         properties: {
           file_key: {
             type: 'string',
-            description: 'The key of the Figma file to retrieve comments from.'
+            description: 'The key of the Figma file to retrieve styles from.'
           }
         },
         required: ['file_key']

package/tools/figma/figma-api/{get-images.js → list-variables-for-a-file.js}

@@ -1,16 +1,16 @@
 /**
- * Function to retrieve images associated with a Figma file.
+ * Function to list variables for a specific 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.
+ * @param {Object} args - Arguments for the request.
+ * @param {string} args.file_key - The key of the Figma file for which to list variables.
+ * @returns {Promise<Object>} - The response containing the variable collections and variables defined in the specified Figma file.
  */
 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 image retrieval
-    const url = `${baseUrl}/files/${file_key}/images`;
+    // Construct the URL for the request
+    const url = `${baseUrl}/v1/files/${file_key}/variables`;
 
     // Set up headers for the request
     const headers = {
@@ -33,13 +33,13 @@ const executeFunction = async ({ file_key }) => {
     const data = await response.json();
     return data;
   } catch (error) {
-    console.error('Error retrieving images:', error);
-    return { error: 'An error occurred while retrieving images.' };
+    console.error('Error listing variables for the file:', error);
+    return { error: 'An error occurred while listing variables for the file.' };
   }
 };
 
 /**
- * Tool configuration for retrieving images from Figma.
+ * Tool configuration for listing variables for a Figma file.
  * @type {Object}
  */
 const apiTool = {
@@ -47,14 +47,14 @@ const apiTool = {
   definition: {
     type: 'function',
     function: {
-      name: 'get_images',
-      description: 'Retrieve images associated with a Figma file.',
+      name: 'list_file_variables',
+      description: 'List variables for a specific 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.'
+            description: 'The key of the Figma file for which to list variables.'
           }
         },
         required: ['file_key']

package/tools/figma/figma-api/post-a-comment-to-a-file.js

@@ -0,0 +1,102 @@
+/**
+ * Function to post a comment to a Figma file.
+ *
+ * @param {Object} args - Arguments for the comment.
+ * @param {string} args.file_key - The key of the Figma file to comment on.
+ * @param {string} args.message - The message of the comment.
+ * @param {Object} [args.client_meta] - Optional metadata for the comment's location.
+ * @param {number} [args.client_meta.x] - The x-coordinate for the comment.
+ * @param {number} [args.client_meta.y] - The y-coordinate for the comment.
+ * @param {string} [args.client_meta.node_id] - The node ID for the comment.
+ * @returns {Promise<Object>} - The result of the comment posting.
+ */
+const executeFunction = async ({ file_key, message, client_meta = {} }) => {
+  const baseUrl = 'https://api.figma.com';
+  const token = process.env.FIGMA_API_KEY;
+
+  try {
+    // Construct the URL for posting a comment
+    const url = `${baseUrl}/v1/files/${file_key}/comments`;
+
+    // Set up headers for the request
+    const headers = {
+      'X-Figma-Token': token,
+      'Content-Type': 'application/json'
+    };
+
+    // Prepare the body of the request
+    const body = JSON.stringify({
+      message,
+      client_meta
+    });
+
+    // Perform the fetch request
+    const response = await fetch(url, {
+      method: 'POST',
+      headers,
+      body
+    });
+
+    // 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 posting comment to Figma file:', error);
+    return { error: 'An error occurred while posting the comment.' };
+  }
+};
+
+/**
+ * Tool configuration for posting comments to a Figma file.
+ * @type {Object}
+ */
+const apiTool = {
+  function: executeFunction,
+  definition: {
+    type: 'function',
+    function: {
+      name: 'post_comment',
+      description: 'Post a comment to a Figma file.',
+      parameters: {
+        type: 'object',
+        properties: {
+          file_key: {
+            type: 'string',
+            description: 'The key of the Figma file to comment on.'
+          },
+          message: {
+            type: 'string',
+            description: 'The message of the comment.'
+          },
+          client_meta: {
+            type: 'object',
+            properties: {
+              x: {
+                type: 'number',
+                description: 'The x-coordinate for the comment.'
+              },
+              y: {
+                type: 'number',
+                description: 'The y-coordinate for the comment.'
+              },
+              node_id: {
+                type: 'string',
+                description: 'The node ID for the comment.'
+              }
+            },
+            description: 'Optional metadata for the comment\'s location.'
+          }
+        },
+        required: ['file_key', 'message']
+      }
+    }
+  }
+};
+
+export { apiTool };