PayPal MCP Server

आधिकारिक

PayPal Model Context Protocol सर्वर आपको फंक्शन कॉलिंग के माध्यम से PayPal APIs के साथ एकीकृत करने की अनुमति देता है। यह प्रोटोकॉल विभिन्न PayPal सेवाओं के साथ इंटरैक्ट करने के लिए विभिन्न टूल्स का समर्थन करता है।

GitHub

187

दस्तावेज़

PayPal एजेंट टूलकिट

PayPal एजेंट टूलकिट लोकप्रिय एजेंट फ्रेमवर्क जैसे OpenAI का एजेंट SDK, LangChain, Vercel का AI SDK, और Model Context Protocol (MCP) को फ़ंक्शन कॉलिंग के माध्यम से PayPal API के साथ एकीकृत करने में सक्षम बनाता है। इसमें TypeScript के लिए समर्थन शामिल है और यह PayPal API और PayPal SDK पर बनाया गया है।

उपलब्ध उपकरण

PayPal एजेंट टूलकिट निम्नलिखित उपकरण प्रदान करता है:

इनवॉइस

create_invoice: PayPal सिस्टम में एक नया इनवॉइस बनाएँ
list_invoices: वैकल्पिक पृष्ठांकन और फ़िल्टरिंग के साथ इनवॉइस सूचीबद्ध करें
get_invoice: किसी विशिष्ट इनवॉइस का विवरण प्राप्त करें
send_invoice: प्राप्तकर्ताओं को इनवॉइस भेजें
send_invoice_reminder: मौजूदा इनवॉइस के लिए अनुस्मारक भेजें
cancel_sent_invoice: भेजे गए इनवॉइस को रद्द करें
generate_invoice_qr_code: इनवॉइस के लिए QR कोड जनरेट करें

भुगतान

create_order: दिए गए विवरणों के आधार पर PayPal सिस्टम में ऑर्डर बनाएँ
get_order: ऑर्डर का विवरण प्राप्त करें
pay_order: अधिकृत ऑर्डर के लिए भुगतान प्रक्रिया करें
create_refund: कैप्चर किए गए भुगतान के लिए रिफ़ंड प्रक्रिया करें।
get_refund: किसी विशिष्ट रिफ़ंड का विवरण प्राप्त करें।

विवाद प्रबंधन

list_disputes: सभी खुले विवादों का सारांश प्राप्त करें
get_dispute: किसी विशिष्ट विवाद की विस्तृत जानकारी प्राप्त करें
accept_dispute_claim: विवाद दावा स्वीकार करें

शिपमेंट ट्रैकिंग

create_shipment_tracking: शिपमेंट ट्रैकिंग रिकॉर्ड बनाएँ
get_shipment_tracking: शिपमेंट ट्रैकिंग जानकारी प्राप्त करें
update_shipment_tracking: शिपमेंट ट्रैकिंग जानकारी अपडेट करें

कैटलॉग प्रबंधन

create_product: PayPal कैटलॉग में एक नया उत्पाद बनाएँ
list_products: वैकल्पिक पृष्ठांकन और फ़िल्टरिंग के साथ उत्पाद सूचीबद्ध करें
show_product_details: किसी विशिष्ट उत्पाद का विवरण प्राप्त करें

सदस्यता प्रबंधन

create_subscription_plan: एक नई सदस्यता योजना बनाएँ
list_subscription_plans: सदस्यता योजनाएँ सूचीबद्ध करें
show_subscription_plan_details: किसी विशिष्ट सदस्यता योजना का विवरण प्राप्त करें
create_subscription: एक नई सदस्यता बनाएँ
show_subscription_details: किसी विशिष्ट सदस्यता का विवरण प्राप्त करें
update_subscription: मौजूदा सदस्यता अपडेट करें
cancel_subscription: सक्रिय सदस्यता रद्द करें

रिपोर्टिंग और अंतर्दृष्टि

list_transactions: वैकल्पिक पृष्ठांकन और फ़िल्टरिंग के साथ लेन-देन सूचीबद्ध करें
get_merchant_insights: व्यापारी के लिए व्यावसायिक बुद्धिमत्ता मीट्रिक्स और विश्लेषण प्राप्त करें

TypeScript

इंस्टॉलेशन

जब तक आप पैकेज को संशोधित नहीं करना चाहते, आपको इस स्रोत कोड की आवश्यकता नहीं है। यदि आप केवल पैकेज का उपयोग करना चाहते हैं तो चलाएँ:

npm install @paypal/agent-toolkit

आवश्यकताएँ

Node 18+

उपयोग

लाइब्रेरी को आपके खाते की क्लाइंट आईडी और सीक्रेट के साथ कॉन्फ़िगर करने की आवश्यकता है जो आपके PayPal डेवलपर डैशबोर्ड में उपलब्ध है।

टूलकिट Vercel के AI SDK के साथ काम करता है और इसे उपकरणों की सूची के रूप में पास किया जा सकता है। अधिक विवरण के लिए, हमारे उदाहरण देखें

import { PayPalAgentToolkit } from '@paypal/agent-toolkit/ai-sdk';
const paypalToolkit = new PayPalAgentToolkit({
  clientId: process.env.PAYPAL_CLIENT_ID,
  clientSecret: process.env.PAYPAL_CLIENT_SECRET,
  configuration: {
    actions: {
      invoices: {
        create: true,
        list: true,
        send: true,
        sendReminder: true,
        cancel: true,
        generateQRC: true,
      },
      products: { create: true, list: true, update: true },
      subscriptionPlans: { create: true, list: true, show: true },
      shipment: { create: true, show: true, cancel: true },
      orders: { create: true, get: true },
      disputes: { list: true, get: true },
    },
  },
});

सैंडबॉक्स मोड का उपयोग करने के लिए, अपने कॉन्फ़िगरेशन में संदर्भ जोड़ें।

configuration: {
  context: {
    sandbox: true,
  }
}

वर्कफ़्लो आरंभ करना

import { PayPalWorkflows, ALL_TOOLS_ENABLED } from '@paypal/agent-toolkit/ai-sdk';
const paypalWorkflows = new PayPalWorkflows({
  clientId: process.env.PAYPAL_CLIENT_ID,
  clientSecret: process.env.PAYPAL_CLIENT_SECRET,
  configuration: {
    actions: ALL_TOOLS_ENABLED,
  },
});

उपयोग

टूलकिट का उपयोग करना

const llm: LanguageModelV1 = getModel(); // The model to be used with ai-sdk
const { text: response } = await generateText({
  model: llm,
  tools: paypalToolkit.getTools(),
  maxSteps: 10,
  prompt: `Create an order for $50 for custom handcrafted item and get the payment link.`,
});

पर्यावरण चर

निम्नलिखित पर्यावरण चर का उपयोग किया जा सकता है:

PAYPAL_ACCESS_TOKEN: आपका PayPal एक्सेस टोकन
PAYPAL_ENVIRONMENT: सैंडबॉक्स मोड के लिए SANDBOX पर सेट करें, उत्पादन के लिए PRODUCTION (डिफ़ॉल्ट SANDBOX मोड है)

यह मार्गदर्शिका बताती है कि PayPal API एकीकरण के लिए एक्सेस टोकन कैसे जनरेट करें, जिसमें आपकी क्लाइंट आईडी और क्लाइंट सीक्रेट कैसे खोजें शामिल है।

पूर्वापेक्षाएँ

PayPal डेवलपर खाता (सैंडबॉक्स के लिए)
PayPal व्यवसाय खाता (उत्पादन के लिए)

अपनी क्लाइंट आईडी और क्लाइंट सीक्रेट ढूँढना

PayPal डेवलपर खाता बनाएँ:
- PayPal डेवलपर डैशबोर्ड पर जाएँ
- अपने PayPal क्रेडेंशियल्स के साथ साइन अप करें या लॉग इन करें
अपने क्रेडेंशियल्स तक पहुँचें:
- डेवलपर डैशबोर्ड में, मेनू में Apps & Credentials पर क्लिक करें
- अपनी आवश्यकताओं के अनुसार Sandbox और Live मोड के बीच स्विच करें
ऐप बनाएँ या देखें:
- नया ऐप बनाने के लिए, Create App पर क्लिक करें
- अपने ऐप को एक नाम दें और इसके साथ संबद्ध करने के लिए एक व्यवसाय खाता चुनें
- मौजूदा ऐप्स के लिए, विवरण देखने के लिए ऐप के नाम पर क्लिक करें
क्रेडेंशियल्स प्राप्त करें:
- एक बार जब आपका ऐप बन जाता है या चयनित हो जाता है, तो आपको एक स्क्रीन दिखाई देगी जिसमें आपके:
  - Client ID: आपके ऐप के लिए एक सार्वजनिक पहचानकर्ता
  - Client Secret: एक निजी कुंजी ("Show" पर क्लिक करने के बाद दिखाई जाती है)
- इन क्रेडेंशियल्स को सुरक्षित रूप से सहेजें क्योंकि एक्सेस टोकन जनरेट करने के लिए इनकी आवश्यकता होती है

एक्सेस टोकन जनरेट करना

cURL का उपयोग करना

curl -v https://api-m.sandbox.paypal.com/v1/oauth2/token \\
  -H \"Accept: application/json\" \\
  -H \"Accept-Language: en_US\" \\
  -u \"CLIENT_ID:CLIENT_SECRET\" \\
  -d \"grant_type=client_credentials\"

CLIENT_ID और CLIENT_SECRET को अपने वास्तविक क्रेडेंशियल्स से बदलें। उत्पादन के लिए, सैंडबॉक्स URL के बजाय https://api-m.paypal.com का उपयोग करें।

Postman का उपयोग करना

https://api-m.sandbox.paypal.com/v1/oauth2/token पर एक नया अनुरोध बनाएँ
विधि को POST पर सेट करें
Authorization के अंतर्गत, Basic Auth चुनें और अपनी क्लाइंट आईडी और क्लाइंट सीक्रेट दर्ज करें
Body के अंतर्गत, x-www-form-urlencoded चुनें और grant_type कुंजी जोड़ें जिसका मान client_credentials हो
अनुरोध भेजें

प्रतिक्रिया

एक सफल प्रतिक्रिया इस तरह दिखेगी:

{
  "scope": "...",
  "access_token": "Your Access Token",
  "token_type": "Bearer",
  "app_id": "APP-80W284485P519543T",
  "expires_in": 32400,
  "nonce": "..."
}

अपने Claude डेस्कटॉप एकीकरण में उपयोग के लिए access_token मान कॉपी करें।

टोकन विवरण

सैंडबॉक्स टोकन: 3-8 घंटों के लिए वैध
उत्पादन टोकन: 8 घंटों के लिए वैध
समाप्ति से पहले टोकन रिफ्रेश लॉजिक लागू करने की अनुशंसा की जाती है

Claude डेस्कटॉप के साथ टोकन का उपयोग करना

एक बार जब आपके पास एक्सेस टोकन हो, तो अपने Claude डेस्कटॉप कनेक्टर कॉन्फ़िगरेशन में PAYPAL_ACCESS_TOKEN मान अपडेट करें:

{
  "env": {
    "PAYPAL_ACCESS_TOKEN": "YOUR_NEW_ACCESS_TOKEN",
    "PAYPAL_ENVIRONMENT": "SANDBOX"
  }
}

सर्वोत्तम अभ्यास

क्लाइंट आईडी और क्लाइंट सीक्रेट को सुरक्षित रूप से संग्रहीत करें
टोकन समाप्ति को संभालने के लिए टोकन रिफ्रेश लॉजिक लागू करें
पर्यावरण-विशिष्ट टोकन का उपयोग करें (परीक्षण के लिए सैंडबॉक्स, वास्तविक लेन-देन के लिए उत्पादन)
एप्लिकेशन कोड में टोकन को हार्डकोड करने से बचें

अस्वीकरण

AI-जनित सामग्री गलत या अधूरी हो सकती है। उपयोगकर्ता किसी भी जानकारी पर भरोसा करने से पहले स्वतंत्र रूप से सत्यापित करने के लिए जिम्मेदार हैं। PayPal आउटपुट सटीकता के संबंध में कोई गारंटी नहीं देता है और इसके उपयोग से उत्पन्न किसी भी निर्णय, कार्रवाई या परिणाम के लिए उत्तरदायी नहीं है।