sendpro-flowmailer-mcp 0.1.1

package/docs/repository-health.md

@@ -0,0 +1,110 @@
+# Repository Health
+
+This document captures the repository conventions used here and the reasoning behind them.
+
+## Structure
+
+Small MCP servers should stay boring and predictable:
+
+```text
+src/                 TypeScript source
+test/                Unit tests
+docs/                Longer documentation
+.github/workflows/   CI, release, security automation
+.github/ISSUE_TEMPLATE/
+README.md            Usage and installation
+CHANGELOG.md         Human-readable change history
+server.json          MCP Registry metadata
+package.json         npm package metadata and scripts
+```
+
+Avoid adding framework folders or generated assets unless the project needs them.
+
+## Community Files
+
+GitHub's community profile checks expect the basics:
+
+- `README.md`
+- `LICENSE`
+- `CONTRIBUTING.md`
+- `CODE_OF_CONDUCT.md`
+- `SECURITY.md`
+- issue templates
+- pull request template
+
+This repository currently reports a 100% community profile from GitHub.
+
+## Badges
+
+Badges are just image links, usually generated by Shields.io or the service itself. They are useful when they communicate real status.
+
+Good badges for this project:
+
+- latest GitHub release
+- CI status
+- OpenSSF Scorecard
+- license
+- supported Node.js version
+- TypeScript
+- MCP transport
+- read-only default
+- npm version and npm downloads
+
+Avoid badges that imply unverifiable claims, such as "Top ranked", "Trending", or "Best" unless a real service computes that status and the badge links to the evidence.
+
+Example badge Markdown:
+
+```markdown
+[![GitHub Release](https://img.shields.io/github/v/release/Mestika/sendpro-flowmailer-mcp?sort=semver&display_name=tag)](https://github.com/Mestika/sendpro-flowmailer-mcp/releases)
+[![npm version](https://img.shields.io/npm/v/sendpro-flowmailer-mcp.svg)](https://www.npmjs.com/package/sendpro-flowmailer-mcp)
+[![npm downloads](https://img.shields.io/npm/dm/sendpro-flowmailer-mcp.svg)](https://www.npmjs.com/package/sendpro-flowmailer-mcp)
+[![CI](https://github.com/Mestika/sendpro-flowmailer-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/Mestika/sendpro-flowmailer-mcp/actions/workflows/ci.yml)
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/Mestika/sendpro-flowmailer-mcp/badge)](https://scorecard.dev/viewer/?uri=github.com/Mestika/sendpro-flowmailer-mcp)
+```
+
+## Branches, Tags, and Releases
+
+Use `main` as the stable branch.
+
+Use short-lived branches for changes:
+
+```text
+fix/read-only-guard
+docs/release-process
+feat/source-user-tools
+```
+
+Use version tags for released snapshots:
+
+```text
+v0.1.0
+v0.1.1
+v0.2.0
+```
+
+A GitHub Release is built from a tag. The tag is the exact source snapshot; the release is the public changelog entry.
+
+## Security Automation
+
+This repository uses:
+
+- Dependabot for dependency and GitHub Actions updates.
+- CI on Node 20, 22, and 24.
+- OpenSSF Scorecard for supply-chain posture.
+
+Recommended GitHub settings:
+
+- Enable secret scanning and push protection if available.
+- Enable private vulnerability reporting.
+- Protect `main` with required CI checks before merge.
+- Delete branches after merge.
+- Prefer squash merges for a tidy history.
+
+## Sources
+
+- [GitHub best practices for repositories](https://docs.github.com/en/repositories/creating-and-managing-repositories/best-practices-for-repositories)
+- [GitHub healthy contribution files](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions)
+- [OpenSSF Scorecard Action](https://github.com/ossf/scorecard-action)
+- [Shields.io](https://shields.io/)
+- [Git branching basics](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell)
+- [GitHub releases](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases)

package/docs/tools.md

@@ -0,0 +1,34 @@
+# Tools
+
+The server exposes tools over MCP stdio.
+
+## Read Tools
+
+- `flowmailer_request`
+- `flowmailer_endpoint_catalog`
+- `flowmailer_list_messages`
+- `flowmailer_get_message`
+- `flowmailer_get_message_archive`
+- `flowmailer_get_message_error_archive`
+- `flowmailer_get_recipient`
+- `flowmailer_list_resource`
+
+## Write Tools
+
+Write tools are registered only when `SENDPRO_READ_ONLY=false`.
+
+- `flowmailer_submit_message`
+- `flowmailer_simulate_message`
+- `flowmailer_resend_message`
+
+## Generic Requests
+
+Use `flowmailer_request` for endpoints not yet covered by a convenience tool. The path must be relative and start with `/`.
+
+In read-only mode the generic request schema only accepts:
+
+```json
+{
+  "method": "GET"
+}
+```

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "sendpro-flowmailer-mcp",
+  "version": "0.1.1",
+  "description": "Unofficial MCP server for Spotler SendPro, formerly FlowMailer.",
+  "type": "module",
+  "mcpName": "io.github.mestika/sendpro-flowmailer-mcp",
+  "bin": {
+    "sendpro-flowmailer-mcp": "dist/index.js",
+    "sendpro-mcp": "dist/index.js",
+    "spotler-sendpro-mcp": "dist/index.js",
+    "flowmailer-sendpro-mcp": "dist/index.js"
+  },
+  "files": [
+    "dist",
+    "docs",
+    "README.md",
+    ".env.example",
+    "server.json"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "check": "npm run typecheck && npm test && npm run build",
+    "dev": "tsx src/index.ts",
+    "inspect": "npx -y @modelcontextprotocol/inspector node dist/index.js",
+    "prepack": "npm run build",
+    "prepublishOnly": "npm run check",
+    "prepare": "npm run build",
+    "version:major": "npm version major -m \"Release v%s\"",
+    "version:minor": "npm version minor -m \"Release v%s\"",
+    "version:patch": "npm version patch -m \"Release v%s\"",
+    "test": "vitest run",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.29.0",
+    "dotenv": "^17.4.2",
+    "zod": "^4.4.3"
+  },
+  "devDependencies": {
+    "@types/node": "^24.10.1",
+    "tsx": "^4.20.6",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.6"
+  },
+  "keywords": [
+    "mcp",
+    "model-context-protocol",
+    "sendpro",
+    "spotler",
+    "flowmailer",
+    "email",
+    "transactional-email",
+    "sms",
+    "api",
+    "stdio"
+  ],
+  "author": "Mestika",
+  "license": "MIT",
+  "homepage": "https://github.com/Mestika/sendpro-flowmailer-mcp#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Mestika/sendpro-flowmailer-mcp.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Mestika/sendpro-flowmailer-mcp/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/server.json

@@ -0,0 +1,59 @@
+{
+  "$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
+  "name": "io.github.mestika/sendpro-flowmailer-mcp",
+  "title": "Spotler SendPro / FlowMailer",
+  "description": "Unofficial MCP server for the Spotler SendPro API, formerly FlowMailer.",
+  "version": "0.1.1",
+  "websiteUrl": "https://github.com/Mestika/sendpro-flowmailer-mcp#readme",
+  "repository": {
+    "url": "https://github.com/Mestika/sendpro-flowmailer-mcp",
+    "source": "github"
+  },
+  "packages": [
+    {
+      "registryType": "npm",
+      "registryBaseUrl": "https://registry.npmjs.org",
+      "identifier": "sendpro-flowmailer-mcp",
+      "version": "0.1.1",
+      "runtimeHint": "npx",
+      "transport": {
+        "type": "stdio"
+      },
+      "environmentVariables": [
+        {
+          "name": "SENDPRO_ACCOUNT_ID",
+          "description": "Spotler SendPro account id.",
+          "isRequired": true,
+          "isSecret": false
+        },
+        {
+          "name": "SENDPRO_CLIENT_ID",
+          "description": "OAuth client id for the SendPro API.",
+          "isRequired": true,
+          "isSecret": true
+        },
+        {
+          "name": "SENDPRO_CLIENT_SECRET",
+          "description": "OAuth client secret for the SendPro API.",
+          "isRequired": true,
+          "isSecret": true
+        },
+        {
+          "name": "SENDPRO_READ_ONLY",
+          "description": "Set to true to allow only SendPro read requests. Defaults to true.",
+          "default": "true",
+          "isRequired": false,
+          "isSecret": false
+        }
+      ]
+    }
+  ],
+  "_meta": {
+    "io.modelcontextprotocol.registry/publisher-provided": {
+      "publisher": "Mestika",
+      "unofficial": true,
+      "legacyNames": ["FlowMailer"],
+      "vendor": "Spotler SendPro"
+    }
+  }
+}