meta-ads-mcp 0.2.6__tar.gz → 0.2.9__tar.gz

meta_ads_mcp-0.2.9/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

{meta_ads_mcp-0.2.6 → meta_ads_mcp-0.2.9}/PKG-INFO

@@ -1,11 +1,12 @@
 Metadata-Version: 2.4
 Name: meta-ads-mcp
-Version: 0.2.6
+Version: 0.2.9
 Summary: Model Calling Protocol (MCP) plugin for interacting with Meta Ads API
 Project-URL: Homepage, https://github.com/nictuku/meta-ads-mcp
 Project-URL: Bug Tracker, https://github.com/nictuku/meta-ads-mcp/issues
 Author-email: Your Name <your.email@example.com>
 License: MIT
+License-File: LICENSE
 Keywords: ads,api,claude,facebook,mcp,meta
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
@@ -15,6 +16,7 @@ Requires-Dist: httpx>=0.26.0
 Requires-Dist: mcp[cli]>=1.6.0
 Requires-Dist: pathlib>=1.0.1
 Requires-Dist: pillow>=10.0.0
+Requires-Dist: python-dateutil>=2.8.2
 Requires-Dist: python-dotenv>=1.1.0
 Requires-Dist: requests>=2.32.3
 Description-Content-Type: text/markdown
@@ -25,6 +27,10 @@ A [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server for in
 
 > **DISCLAIMER:** This is an unofficial third-party tool and is not associated with, endorsed by, or affiliated with Meta in any way. This project is maintained independently and uses Meta's public APIs according to their terms of service. Meta, Facebook, Instagram, and other Meta brand names are trademarks of their respective owners.
 
+<a href="https://glama.ai/mcp/servers/@pipeboard-co/meta-ads-mcp">
+  <img width="380" height="200" src="https://glama.ai/mcp/servers/@pipeboard-co/meta-ads-mcp/badge" alt="Meta Ads MCP server" />
+</a>
+
 Screenhot: using an LLM to understand your ad performance.
 
 ![Meta Ads MCP in action: Visualize ad performance metrics and creative details directly in Claude or your favorite MCP client, with rich insights about campaign reach, engagement, and costs](./images/meta-ads-example.png)
@@ -49,6 +55,11 @@ Screenhot: using an LLM to understand your ad performance.
 When using uv no specific installation is needed. We can use uvx to directly run meta-ads-mcp:
 
 ```bash
+# RECOMMENDED: Use with Pipeboard authentication
+export PIPEBOARD_API_TOKEN=your_pipeboard_token  # Get your token at https://pipeboard.co
+uvx meta-ads-mcp
+
+# Alternative: Use with direct Meta authentication
 uvx meta-ads-mcp --app-id YOUR_META_ADS_APP_ID
 ```
 
@@ -76,14 +87,49 @@ pip install meta-ads-mcp
 After installation, you can run it as:
 
 ```bash
+# RECOMMENDED: Use with Pipeboard authentication
+export PIPEBOARD_API_TOKEN=your_pipeboard_token  # Get your token at https://pipeboard.co
 python -m meta_ads_mcp
+
+# Alternative: Use with direct Meta authentication
+python -m meta_ads_mcp --app-id YOUR_META_ADS_APP_ID
 ```
 
 ## Configuration
 
-### Usage with Claude in Cursor
+### Quick Start with Pipeboard Authentication (Recommended)
+
+The easiest way to configure Meta Ads MCP is using Pipeboard authentication:
+
+1. Sign up at [Pipeboard.co](https://pipeboard.co) and generate an API token - **Get your free token at [https://pipeboard.co](https://pipeboard.co)**
+2. Set the environment variable:
+   ```bash
+   export PIPEBOARD_API_TOKEN=your_pipeboard_token   # Token obtainable via https://pipeboard.co
+   ```
+3. Run meta-ads-mcp without needing to set up a Meta Developer App:
+   ```bash
+   uvx meta-ads-mcp
+   ```
+
+This method provides longer-lived tokens (60 days), simplified setup, and automatic token renewal.
+
+### Usage with Cursor or Claude Desktop
+
+Add this to your `claude_desktop_config.json` to integrate with Claude or `~/.cursor/mcp.json` to integrate with Cursor:
 
-Add this to your `claude_desktop_config.json` to integrate with Claude in Cursor:
+```json
+"mcpServers": {
+  "meta-ads": {
+    "command": "uvx",
+    "args": ["meta-ads-mcp"],
+    "env": {
+      "PIPEBOARD_API_TOKEN": "your_pipeboard_token"  // Token obtainable via https://pipeboard.co
+    }
+  }
+}
+```
+
+Or if you prefer direct Meta authentication (using your own Facebook app):
 
 ```json
 "mcpServers": {
@@ -228,6 +274,7 @@ Add this to your `claude_desktop_config.json` to integrate with Claude in Cursor
 
 16. `mcp_meta_ads_get_login_link`
     - Get a clickable login link for Meta Ads authentication
+    - NOTE: This method should only be used if you're using your own Facebook app. If using Pipeboard authentication (recommended), set the PIPEBOARD_API_TOKEN environment variable instead (token obtainable via https://pipeboard.co).
     - Inputs:
       - `access_token` (optional): Meta API access token (will use cached token if not provided)
     - Returns: A clickable resource link for Meta authentication
@@ -244,13 +291,47 @@ Before using the MCP server, you'll need to set up a Meta Developer App:
 
 ## Authentication
 
-The Meta Ads MCP uses the OAuth 2.0 flow designed for desktop apps. When authenticating, it will:
+The Meta Ads MCP supports two authentication methods:
+
+### 1. Pipeboard Authentication (Recommended ⭐)
+
+This method uses [Pipeboard.co](https://pipeboard.co) to manage Meta API authentication, providing longer-lived tokens and a simplified flow:
+
+1. **Get your Pipeboard token**: Sign up at [https://pipeboard.co](https://pipeboard.co) to generate your free API token
+2. Set the `PIPEBOARD_API_TOKEN` environment variable with your token: 
+   ```bash
+   export PIPEBOARD_API_TOKEN=your_pipeboard_token
+   ```
+3. Run the Meta Ads MCP normally - it will automatically detect and use Pipeboard authentication:
+   ```bash
+   uvx meta-ads-mcp
+   ```
+4. The first time you run a command, you'll be provided with a login URL to authorize with Meta
+
+**Benefits of Pipeboard authentication:**
+- ✅ Longer-lived tokens (60 days)
+- ✅ No need to configure a Meta Developer App
+- ✅ Simpler setup with just an API token
+- ✅ Automatic token renewal
+
+To test the Pipeboard authentication flow:
+```bash
+python test_pipeboard_auth.py --api-token YOUR_PIPEBOARD_TOKEN
+```
+
+### 2. Direct Meta OAuth (Legacy)
+
+The traditional OAuth 2.0 flow designed for desktop apps. This method should only be used if you are using your own Facebook app instead of Pipeboard.
+
+When authenticating, it will:
 
 1. Start a local callback server on your machine
 2. Open a browser window to authenticate with Meta
 3. Ask you to authorize the app
 4. Redirect back to the local server to extract and store the token securely
 
+This method requires you to [create a Meta Developer App](#create-a-meta-developer-app) first.
+
 ## Troubleshooting and Logging
 
 The Meta Ads MCP includes a comprehensive logging system to help troubleshoot issues:
@@ -265,21 +346,29 @@ Log files are stored in a platform-specific location:
 
 ### Common Issues
 
-#### App ID Issues
+#### Authentication Issues
+
+If you're having authentication problems:
 
-If you encounter errors like `(#200) Provide valid app ID`, check the following:
+1. **Recommended: Use Pipeboard Authentication**
+   - Set `export PIPEBOARD_API_TOKEN=your_token` and retry
+   - This provides longer-lived tokens and better reliability
+   - Verify your token in the Pipeboard dashboard
 
-1. Ensure you've set up a Meta Developer App correctly
-2. Verify that you're passing the correct App ID using one of these methods:
-   - Set the `META_APP_ID` environment variable: `export META_APP_ID=your_app_id`
-   - Pass it as a command-line argument: `meta-ads-mcp --app-id your_app_id`
+2. For App ID issues (when using direct authentication):
+   If you encounter errors like `(#200) Provide valid app ID`, check the following:
+   - Ensure you've set up a Meta Developer App correctly
+   - Verify that you're passing the correct App ID using one of these methods:
+     - Set the `META_APP_ID` environment variable: `export META_APP_ID=your_app_id`
+     - Pass it as a command-line argument: `meta-ads-mcp --app-id your_app_id`
 
-#### Authentication Errors
+#### API Errors
 
-Authentication errors can be tracked in the log file. Check for:
-- Token expiration issues
-- App permission problems
-- Connection errors
+If you receive errors from the Meta API:
+
+1. Verify your app has the Marketing API product added
+2. Ensure the user has appropriate permissions on the ad accounts
+3. Check if there are rate limits or other restrictions on your app
 
 ### Debugging Command
 
@@ -310,14 +399,15 @@ uvx meta-ads-mcp --app-id=your_app_id
 The Meta Ads MCP follows security best practices:
 
 1. Tokens are cached in a platform-specific secure location:
-   - Windows: `%APPDATA%\meta-ads-mcp\token_cache.json`
-   - macOS: `~/Library/Application Support/meta-ads-mcp/token_cache.json`
-   - Linux: `~/.config/meta-ads-mcp/token_cache.json`
+   - Windows: `%APPDATA%\meta-ads-mcp\token_cache.json` or `%APPDATA%\meta-ads-mcp\pipeboard_token_cache.json`
+   - macOS: `~/Library/Application Support/meta-ads-mcp/token_cache.json` or `~/Library/Application Support/meta-ads-mcp/pipeboard_token_cache.json`
+   - Linux: `~/.config/meta-ads-mcp/token_cache.json` or `~/.config/meta-ads-mcp/pipeboard_token_cache.json`
 
 2. You do not need to provide your access token for each command; it will be automatically retrieved from the cache.
 
 3. You can set the following environment variables instead of passing them as arguments:
-   - `META_APP_ID`: Your Meta App ID (Client ID)
+   - `META_APP_ID`: Your Meta App ID (Client ID) - for direct OAuth method
+   - `PIPEBOARD_API_TOKEN`: Your Pipeboard API token - for Pipeboard authentication method
 
 ## Testing
 
@@ -339,11 +429,12 @@ python test_meta_ads_auth.py --app-id YOUR_APP_ID --force-login
 
 When using the Meta Ads MCP with an LLM interface (like Claude):
 
-1. Test authentication by calling the `mcp_meta_ads_get_login_link` tool
-2. Verify account access by calling `mcp_meta_ads_get_ad_accounts`
-3. Check specific account details with `mcp_meta_ads_get_account_info`
+1. If using direct Meta authentication (your own Facebook app), test authentication by calling the `mcp_meta_ads_get_login_link` tool
+2. If using Pipeboard authentication (recommended), ensure the PIPEBOARD_API_TOKEN environment variable is set (token obtainable via https://pipeboard.co)
+3. Verify account access by calling `mcp_meta_ads_get_ad_accounts`
+4. Check specific account details with `mcp_meta_ads_get_account_info`
 
-These functions will automatically handle authentication if needed and provide a clickable login link.
+These functions will automatically handle authentication if needed and provide a clickable login link if required.
 
 ## Troubleshooting
 
@@ -352,20 +443,20 @@ These functions will automatically handle authentication if needed and provide a
 If you encounter authentication issues:
 
 1. When using the LLM interface:
-   - Use the `mcp_meta_ads_get_login_link` tool to generate a fresh authentication link
+   - If using direct Meta authentication (your own Facebook app), use the `mcp_meta_ads_get_login_link` tool to generate a fresh authentication link
+   - If using Pipeboard authentication (recommended), ensure the PIPEBOARD_API_TOKEN environment variable is set (token obtainable via https://pipeboard.co)
    - Ensure you click the link and complete the authorization flow in your browser
    - Check that the callback server is running properly (the tool will report this)
 
-2. When using the command line:
+2. When using Pipeboard authentication:
+   - Verify your `PIPEBOARD_API_TOKEN` is set correctly (token obtainable via https://pipeboard.co)
+   - Check if you need to complete the authorization process by visiting the provided login URL
+   - Try forcing a new login: `python test_pipeboard_auth.py --force-login`
+
+3. When using direct Meta OAuth:
    - Run with `--force-login` to get a fresh token: `uvx meta-ads-mcp --login --app-id YOUR_APP_ID --force-login`
    - Make sure the terminal has permissions to open a browser window
 
-3. General authentication troubleshooting:
-   - Check that your app is properly configured in the Meta Developers portal
-   - Ensure your app has the necessary permissions (ads_management, ads_read, business_management)
-   - Verify the app's redirect URI includes `http://localhost:8888/callback`
-   - Try clearing the token cache (located in platform-specific directories listed in the Token Caching section)
-
 ### API Errors
 
 If you receive errors from the Meta API: