4 practices for crafting integration development prompts

Do not index

In the realm of AI and software development, crafting the perfect prompt can make a huge difference in the outcomes you achieve.

This concept, known as prompt engineering, is not only applicable to interacting with AI models but also incredibly relevant when building integrations for SaaS platforms (our favorite thing at Lunch Pail Labs). With that said, let’s dive into a few best practices I keep in mind when creating prompts at Lunch Pail Labs for building integrations.

1. Detail is key

When it comes to integrations, the devil is in the details. Providing clear, concise, and comprehensive information from the get-go can significantly improve the accuracy and relevance of AI’s responses.

You’ll write better prompts if you familiarize yourself with the docs!

Less effective ❌:

Generate code for sending emails

Better ✅:

Create a Node.js request to send an email via SendGrid's API, 
adhering to the example request format. Only use the specified parameters below.
Parameters###
##
Example request format ###
###

2. Cut the fluff

Avoid vague or ambiguous terms. Be straightforward and declarative in your requests to avoid misunderstandings.

Less effective ❌:

Can you please create a Node.js script to add new contacts to my HubSpot CRM
Here's some more information.  
Thanks so much for your help!

Better ✅

Create a Node.js request to add new contacts to Hubspot. Adhere to the example request format.  Only use the specified parameters below.

3. Use delimiters for clarity

Separating different parts of your prompt, such as instructions and context, can help keep your request organized and clear.

This is especially useful when dealing with complex integrations that involve multiple steps or conditions.

Less effective ❌:

Create a Node.js request to charge a payment using Stripe's API. It should be for $1000 
and have a description "payment for services". 
Also here's a format that you can model the request after from Stripe's documentation

const stripe = require('stripe')('sk_test_4eC39HqLyjWDarjtT1zdp7dc');

const paymentIntent = await stripe.paymentIntents.create({
  amount: 2000,
  currency: 'usd',
  automatic_payment_methods: {
    enabled: true,
  },
});

Better ✅:

Create a Node.js request to charge a payment using Stripe's API. Adhere to the example request format. Only use the specified parameters below.

Parameters ###:
- amount: 1000
- currency: usd
- description: payment for services
###


Example request format ###:
const stripe = require('stripe')('sk_test_4eC39HqLyjWDarjtT1zdp7dc');

const paymentIntent = await stripe.paymentIntents.create({
  amount: 2000,
  currency: 'usd',
  automatic_payment_methods: {
    enabled: true,
  },
});
###

4. Request explanations

Asking for explanations or documentation on how the integration meets specific requirements can provide insights into the AI’s logic and decision-making process.

This practice helps to translate the output back into something you can understand

Less effective ❌:

Create a Node.js  script to create a new video room. Adhere to the example request format. 
Only use the specified parameters below.

Better ✅:

Create a Node.js script to create a new video room. Adhere to the example request format. 
Only use the specified parameters below.  Explain the generated code, and how  it fulfills the provided instruction

By applying these principles from prompt engineering to your integration-building efforts, you can enhance the precision, efficiency, and effectiveness of your integrations and speed up the time it takes to generate third-party code.

For expert guidance on building integrations, Lunch Pail Labs is here to help. We're happy to discuss integrations and help you accelerate your integration coverage. Feel free to book an introductory call to chat further.

4 practices for crafting integration development prompts

1. Detail is key

2. Cut the fluff

3. Use delimiters for clarity

4. Request explanations

Focus on your business, we'll handle integrations

Build Better Integrations