withfeedback-mcp 0.1.0__tar.gz

withfeedback_mcp-0.1.0/.gitignore

@@ -0,0 +1,304 @@
+local_password.txt
+AGENTS-local.md
+dev.sh
+/media/*
+### VisualStudioCode template
+.vscode/*
+
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+.idea/*
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### Linux template
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### Windows template
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+### macOS template
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+/env/
+/tailwindcss
+
+node_modules/
+/staticfiles/*

withfeedback_mcp-0.1.0/PKG-INFO

@@ -0,0 +1,199 @@
+Metadata-Version: 2.5
+Name: withfeedback-mcp
+Version: 0.1.0
+Summary: MCP server for withfeedback.com — testimonials, feedback moderation, widgets, and NPS for AI agents
+Project-URL: Homepage, https://withfeedback.com
+Project-URL: Documentation, https://withfeedback.com/api/docs/
+License: MIT
+Keywords: feedback,mcp,testimonials,withfeedback
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27
+Requires-Dist: mcp>=1.2
+Description-Content-Type: text/markdown
+
+# withfeedback-mcp
+
+MCP (Model Context Protocol) server for [withfeedback.com](https://withfeedback.com):
+lets AI assistants (Claude, Cursor, …) list and moderate feedback submissions,
+create and bulk-import testimonials, inspect widgets and embed codes, and read
+NPS survey results.
+
+Transports: **stdio** (default) and **streamable HTTP** (`withfeedback-mcp --http`
+or `WITHFEEDBACK_MCP_TRANSPORT=http`). HTTP mode binds `127.0.0.1` only —
+see the security note below before changing that.
+
+## Install
+
+```bash
+pip install withfeedback-mcp
+# or run without installing:
+uvx withfeedback-mcp
+```
+
+## Quick start with a personal access token (PAT)
+
+The recommended setup for a local/stdio MCP server:
+
+1. Log in at your withfeedback.com instance and open **Account → API Tokens**
+   (`/accounts/tokens/`).
+2. Create a token with the scopes you need (see the table below). Copy it —
+   it is shown only once.
+3. Configure your MCP client with `WITHFEEDBACK_TOKEN` (examples below).
+
+API access requires a plan that includes the API/CLI/MCP feature (Pro and
+above). Requests from lower plans return HTTP 403.
+
+## Claude Desktop / Claude Code configuration
+
+Claude Desktop (`claude_desktop_config.json`):
+
+```json
+{
+  "mcpServers": {
+    "withfeedback": {
+      "command": "uvx",
+      "args": ["withfeedback-mcp"],
+      "env": {
+        "WITHFEEDBACK_TOKEN": "spd_your_token_here"
+      }
+    }
+  }
+}
+```
+
+Prefer the OAuth2 device flow over a PAT? Omit `WITHFEEDBACK_TOKEN` — the
+official public client id `7yQMsnY2Is2f5tCuwwgItoQu3fRkEX2wnzIRj0Vh` is the
+built-in default (shown here explicitly; only needed to override):
+
+```json
+{
+  "mcpServers": {
+    "withfeedback": {
+      "command": "uvx",
+      "args": ["withfeedback-mcp"],
+      "env": {
+        "WITHFEEDBACK_CLIENT_ID": "7yQMsnY2Is2f5tCuwwgItoQu3fRkEX2wnzIRj0Vh"
+      }
+    }
+  }
+}
+```
+
+Claude Code:
+
+```bash
+claude mcp add withfeedback --env WITHFEEDBACK_TOKEN=spd_your_token_here -- uvx withfeedback-mcp
+```
+
+## Cursor configuration
+
+`~/.cursor/mcp.json` (or the project's `.cursor/mcp.json`):
+
+```json
+{
+  "mcpServers": {
+    "withfeedback": {
+      "command": "uvx",
+      "args": ["withfeedback-mcp"],
+      "env": {
+        "WITHFEEDBACK_TOKEN": "spd_your_token_here"
+      }
+    }
+  }
+}
+```
+
+## OAuth2 device flow (alternative to a PAT)
+
+If `WITHFEEDBACK_TOKEN` is not set, the server falls back to the OAuth2
+device flow using the **official public client id**
+`7yQMsnY2Is2f5tCuwwgItoQu3fRkEX2wnzIRj0Vh` (public by design — device-flow
+clients carry no secret). Set `WITHFEEDBACK_CLIENT_ID` to use a different
+client (e.g. on a self-hosted instance). On the first tool call the server
+prints a verification URL and a short code on stderr (and tries to open your
+browser):
+
+1. The server calls `POST /o/device-authorization/` with the client id.
+2. You open the printed URL, enter the code, and approve the requested scopes.
+3. The server polls `POST /o/token/` until approval and then uses the access
+   token for all API calls.
+
+Request a custom scope set with `WITHFEEDBACK_SCOPES` (space-separated).
+
+**Note on Dynamic Client Registration:** open DCR (`POST /o/register/`) is
+**disabled in production** (`DCR_ENABLED=False` is the production default) —
+the endpoint is unauthenticated and unthrottled, so withfeedback.com does not
+expose it. Use the published official client id (or a PAT); self-hosted
+instances can register additional clients via Django admin or the
+`create_oauth2_app` management command.
+
+## Environment variables
+
+| Variable | Default | Purpose |
+|---|---|---|
+| `WITHFEEDBACK_API_URL` | `https://withfeedback.com` | API base URL (self-hosted/staging override) |
+| `WITHFEEDBACK_TOKEN` | — | Personal access token (primary auth for stdio) |
+| `WITHFEEDBACK_CLIENT_ID` | official public client id | OAuth2 client id for the device-flow fallback |
+| `WITHFEEDBACK_SCOPES` | all tool scopes | Scopes requested during device flow |
+| `WITHFEEDBACK_MCP_TRANSPORT` | `stdio` | Set to `http` for streamable HTTP |
+| `WITHFEEDBACK_MCP_HOST` | `127.0.0.1` | HTTP bind address (loopback only by default) |
+| `WITHFEEDBACK_MCP_PORT` | `8000` | HTTP bind port |
+| `WITHFEEDBACK_MCP_ALLOW_REMOTE` | unset | Must be `1` to allow a non-loopback HTTP bind (read the security note first) |
+
+On startup the server checks `GET /.well-known/speedpy.json` once and warns
+(never fails) when the manifest is unreachable or the API is older than the
+minimum this client expects.
+
+## HTTP transport security
+
+The streamable HTTP transport has **no per-caller authentication**: the
+process holds a single account token (your PAT or device-flow grant), and
+every HTTP caller acts as that account. Therefore:
+
+- HTTP mode binds **`127.0.0.1` by default** and is intended for local
+  clients on the same machine.
+- Binding a non-loopback address is **refused** unless you explicitly set
+  `WITHFEEDBACK_MCP_ALLOW_REMOTE=1`, and even then the server prints a
+  prominent warning: only do this behind a reverse proxy that authenticates
+  callers before they can reach the port.
+- A properly multi-tenant **remote MCP server with per-user OAuth is a
+  future server-side deployment of withfeedback.com** — it is not something
+  this package provides. Do not expose this process to the internet.
+
+## Tools and required scopes
+
+Give your PAT (or device-flow grant) the scopes for the tools you plan to use:
+
+| Tool | Endpoint(s) | Required scope |
+|---|---|---|
+| `list_teams` | `GET /api/v1/teams/` | `read:teams` |
+| `list_projects` | `GET /api/v1/teams/{team}/projects/` | `read:feedback` |
+| `list_submissions` | `GET …/projects/{id}/submissions/` | `read:feedback` |
+| `get_submission` | `GET …/submissions/{id}/` | `read:feedback` |
+| `approve_submission` | `POST …/submissions/{id}/approve/` | `moderate:submissions` |
+| `reject_submission` | `POST …/submissions/{id}/reject/` | `moderate:submissions` |
+| `create_testimonial` | `POST …/projects/{id}/submissions/` | `write:testimonials` |
+| `import_testimonials` | `POST …/projects/{id}/submissions/` (looped, ≤100 items) | `write:testimonials` |
+| `list_widgets` | `GET …/projects/{id}/widgets/` | `read:widgets` |
+| `get_widget_embed_code` | `GET …/widgets/{id}/embed-code/` | `read:widgets` |
+| `get_nps_summary` | `GET …/surveys/` + `GET …/surveys/{id}/results/` | `read:surveys` |
+
+Notes:
+
+- **Moderation is explicit and audited.** `approve_submission` /
+  `reject_submission` call the dedicated action endpoints; `write:*` scopes
+  cannot approve — only `moderate:submissions` can. Responses include the
+  submission `id`, `status`, `moderated_by_id`, and `moderated_at`, so agent
+  actions stay attributable in the moderation audit trail.
+- **Nothing is auto-published.** `create_testimonial` and
+  `import_testimonials` always create *pending* submissions that a moderation
+  step (human or explicit approve call) must publish.
+- API errors surface as readable tool errors: HTTP 402 = plan quota/billing
+  block, HTTP 403 = missing scope/role/plan feature, HTTP 409 = invalid
+  moderation state transition.
+
+## Development
+
+```bash
+uv run --with pytest --with httpx --with mcp pytest packages/withfeedback-mcp/
+```

withfeedback_mcp-0.1.0/README.md

@@ -0,0 +1,186 @@
+# withfeedback-mcp
+
+MCP (Model Context Protocol) server for [withfeedback.com](https://withfeedback.com):
+lets AI assistants (Claude, Cursor, …) list and moderate feedback submissions,
+create and bulk-import testimonials, inspect widgets and embed codes, and read
+NPS survey results.
+
+Transports: **stdio** (default) and **streamable HTTP** (`withfeedback-mcp --http`
+or `WITHFEEDBACK_MCP_TRANSPORT=http`). HTTP mode binds `127.0.0.1` only —
+see the security note below before changing that.
+
+## Install
+
+```bash
+pip install withfeedback-mcp
+# or run without installing:
+uvx withfeedback-mcp
+```
+
+## Quick start with a personal access token (PAT)
+
+The recommended setup for a local/stdio MCP server:
+
+1. Log in at your withfeedback.com instance and open **Account → API Tokens**
+   (`/accounts/tokens/`).
+2. Create a token with the scopes you need (see the table below). Copy it —
+   it is shown only once.
+3. Configure your MCP client with `WITHFEEDBACK_TOKEN` (examples below).
+
+API access requires a plan that includes the API/CLI/MCP feature (Pro and
+above). Requests from lower plans return HTTP 403.
+
+## Claude Desktop / Claude Code configuration
+
+Claude Desktop (`claude_desktop_config.json`):
+
+```json
+{
+  "mcpServers": {
+    "withfeedback": {
+      "command": "uvx",
+      "args": ["withfeedback-mcp"],
+      "env": {
+        "WITHFEEDBACK_TOKEN": "spd_your_token_here"
+      }
+    }
+  }
+}
+```
+
+Prefer the OAuth2 device flow over a PAT? Omit `WITHFEEDBACK_TOKEN` — the
+official public client id `7yQMsnY2Is2f5tCuwwgItoQu3fRkEX2wnzIRj0Vh` is the
+built-in default (shown here explicitly; only needed to override):
+
+```json
+{
+  "mcpServers": {
+    "withfeedback": {
+      "command": "uvx",
+      "args": ["withfeedback-mcp"],
+      "env": {
+        "WITHFEEDBACK_CLIENT_ID": "7yQMsnY2Is2f5tCuwwgItoQu3fRkEX2wnzIRj0Vh"
+      }
+    }
+  }
+}
+```
+
+Claude Code:
+
+```bash
+claude mcp add withfeedback --env WITHFEEDBACK_TOKEN=spd_your_token_here -- uvx withfeedback-mcp
+```
+
+## Cursor configuration
+
+`~/.cursor/mcp.json` (or the project's `.cursor/mcp.json`):
+
+```json
+{
+  "mcpServers": {
+    "withfeedback": {
+      "command": "uvx",
+      "args": ["withfeedback-mcp"],
+      "env": {
+        "WITHFEEDBACK_TOKEN": "spd_your_token_here"
+      }
+    }
+  }
+}
+```
+
+## OAuth2 device flow (alternative to a PAT)
+
+If `WITHFEEDBACK_TOKEN` is not set, the server falls back to the OAuth2
+device flow using the **official public client id**
+`7yQMsnY2Is2f5tCuwwgItoQu3fRkEX2wnzIRj0Vh` (public by design — device-flow
+clients carry no secret). Set `WITHFEEDBACK_CLIENT_ID` to use a different
+client (e.g. on a self-hosted instance). On the first tool call the server
+prints a verification URL and a short code on stderr (and tries to open your
+browser):
+
+1. The server calls `POST /o/device-authorization/` with the client id.
+2. You open the printed URL, enter the code, and approve the requested scopes.
+3. The server polls `POST /o/token/` until approval and then uses the access
+   token for all API calls.
+
+Request a custom scope set with `WITHFEEDBACK_SCOPES` (space-separated).
+
+**Note on Dynamic Client Registration:** open DCR (`POST /o/register/`) is
+**disabled in production** (`DCR_ENABLED=False` is the production default) —
+the endpoint is unauthenticated and unthrottled, so withfeedback.com does not
+expose it. Use the published official client id (or a PAT); self-hosted
+instances can register additional clients via Django admin or the
+`create_oauth2_app` management command.
+
+## Environment variables
+
+| Variable | Default | Purpose |
+|---|---|---|
+| `WITHFEEDBACK_API_URL` | `https://withfeedback.com` | API base URL (self-hosted/staging override) |
+| `WITHFEEDBACK_TOKEN` | — | Personal access token (primary auth for stdio) |
+| `WITHFEEDBACK_CLIENT_ID` | official public client id | OAuth2 client id for the device-flow fallback |
+| `WITHFEEDBACK_SCOPES` | all tool scopes | Scopes requested during device flow |
+| `WITHFEEDBACK_MCP_TRANSPORT` | `stdio` | Set to `http` for streamable HTTP |
+| `WITHFEEDBACK_MCP_HOST` | `127.0.0.1` | HTTP bind address (loopback only by default) |
+| `WITHFEEDBACK_MCP_PORT` | `8000` | HTTP bind port |
+| `WITHFEEDBACK_MCP_ALLOW_REMOTE` | unset | Must be `1` to allow a non-loopback HTTP bind (read the security note first) |
+
+On startup the server checks `GET /.well-known/speedpy.json` once and warns
+(never fails) when the manifest is unreachable or the API is older than the
+minimum this client expects.
+
+## HTTP transport security
+
+The streamable HTTP transport has **no per-caller authentication**: the
+process holds a single account token (your PAT or device-flow grant), and
+every HTTP caller acts as that account. Therefore:
+
+- HTTP mode binds **`127.0.0.1` by default** and is intended for local
+  clients on the same machine.
+- Binding a non-loopback address is **refused** unless you explicitly set
+  `WITHFEEDBACK_MCP_ALLOW_REMOTE=1`, and even then the server prints a
+  prominent warning: only do this behind a reverse proxy that authenticates
+  callers before they can reach the port.
+- A properly multi-tenant **remote MCP server with per-user OAuth is a
+  future server-side deployment of withfeedback.com** — it is not something
+  this package provides. Do not expose this process to the internet.
+
+## Tools and required scopes
+
+Give your PAT (or device-flow grant) the scopes for the tools you plan to use:
+
+| Tool | Endpoint(s) | Required scope |
+|---|---|---|
+| `list_teams` | `GET /api/v1/teams/` | `read:teams` |
+| `list_projects` | `GET /api/v1/teams/{team}/projects/` | `read:feedback` |
+| `list_submissions` | `GET …/projects/{id}/submissions/` | `read:feedback` |
+| `get_submission` | `GET …/submissions/{id}/` | `read:feedback` |
+| `approve_submission` | `POST …/submissions/{id}/approve/` | `moderate:submissions` |
+| `reject_submission` | `POST …/submissions/{id}/reject/` | `moderate:submissions` |
+| `create_testimonial` | `POST …/projects/{id}/submissions/` | `write:testimonials` |
+| `import_testimonials` | `POST …/projects/{id}/submissions/` (looped, ≤100 items) | `write:testimonials` |
+| `list_widgets` | `GET …/projects/{id}/widgets/` | `read:widgets` |
+| `get_widget_embed_code` | `GET …/widgets/{id}/embed-code/` | `read:widgets` |
+| `get_nps_summary` | `GET …/surveys/` + `GET …/surveys/{id}/results/` | `read:surveys` |
+
+Notes:
+
+- **Moderation is explicit and audited.** `approve_submission` /
+  `reject_submission` call the dedicated action endpoints; `write:*` scopes
+  cannot approve — only `moderate:submissions` can. Responses include the
+  submission `id`, `status`, `moderated_by_id`, and `moderated_at`, so agent
+  actions stay attributable in the moderation audit trail.
+- **Nothing is auto-published.** `create_testimonial` and
+  `import_testimonials` always create *pending* submissions that a moderation
+  step (human or explicit approve call) must publish.
+- API errors surface as readable tool errors: HTTP 402 = plan quota/billing
+  block, HTTP 403 = missing scope/role/plan feature, HTTP 409 = invalid
+  moderation state transition.
+
+## Development
+
+```bash
+uv run --with pytest --with httpx --with mcp pytest packages/withfeedback-mcp/
+```

withfeedback_mcp-0.1.0/pyproject.toml

@@ -0,0 +1,26 @@
+[project]
+name = "withfeedback-mcp"
+version = "0.1.0"
+description = "MCP server for withfeedback.com — testimonials, feedback moderation, widgets, and NPS for AI agents"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+keywords = ["mcp", "testimonials", "feedback", "withfeedback"]
+dependencies = [
+    "mcp>=1.2",
+    "httpx>=0.27",
+]
+
+[project.urls]
+Homepage = "https://withfeedback.com"
+Documentation = "https://withfeedback.com/api/docs/"
+
+[project.scripts]
+withfeedback-mcp = "withfeedback_mcp.server:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/withfeedback_mcp"]