Sherweb
MCP server for Sherweb — billing, subscriptions, customers, and product catalog.
Open source Open in the app JSON README (API)
About
MCP server for Sherweb — billing, subscriptions, customers, and product catalog.
Details
- Kind
- MCP servers
- Topic
- Finance & crypto
- Publisher
- wyre-technology
- Origin
- official
- Category
- ferramentas
- Transport
- local
- Version
- 1.4.3
- Forks
- 1
- Open pull requests
- 1
- Last push
- 2026-09-03T13:07:02Z
- Repository state
- ativo
- Language
- TypeScript
- License
- Apache-2.0
- Added
- 2026-08-29 04:01:41
- Updated
- 2026-08-29 04:01:41
- Origin id
io.github.wyre-technology/sherweb-mcp
README
# Sherweb MCP Server
[](https://opensource.org/licenses/Apache-2.0)
[](https://nodejs.org/)
A Model Context Protocol (MCP) server for Sherweb cloud marketplace and partner portal. Enables AI assistants to manage customer subscriptions, browse the product catalog, and handle billing operations.
This is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server that connects Claude (or any MCP-compatible AI) to your Sherweb environment.
> **Part of the [MSP Claude Plugins](https://github.com/WYRE-AI) ecosystem** — a growing suite of AI integrations for the MSP stack. Built by MSPs, for MSPs.
## Installation
```bash
npm install @wyre-ai/sherweb-mcp
```
## Configuration
Set the following environment variables:
| Variable | Required | Description |
|----------|----------|-------------|
| `SHERWEB_CLIENT_ID` | Yes | Your Sherweb API client ID |
| `SHERWEB_CLIENT_SECRET` | Yes | Your Sherweb API client secret |
| `SHERWEB_SUBSCRIPTION_KEY` | Yes | Your Sherweb subscription key |
| `MCP_TRANSPORT` | No | Transport mode: stdio (default) or http |
## Usage
### Running with Claude Desktop
Add to your Claude Desktop `claude_desktop_config.json`:
```json
{
"mcpServers": {
"sherweb-mcp": {
"command": "npx",
"args": ["@wyre-ai/sherweb-mcp"],
"env": {
"SHERWEB_CLIENT_ID": "your-sherweb-client-id"
"SHERWEB_CLIENT_SECRET": "your-sherweb-client-secret"
"SHERWEB_SUBSCRIPTION_KEY": "your-sherweb-subscription-key"
}
}
}
}
```
### Running with Claude Code (CLI)
```bash
claude mcp add sherweb-mcp \
-e SHERWEB_CLIENT_ID=your-value \
-e SHERWEB_CLIENT_SECRET=your-value \
-e SHERWEB_SUBSCRIPTION_KEY=your-value \
-- npx -y @wyre-ai/sherweb-mcp
```
### Docker
```bash
docker build -t sherweb-mcp .
docker run \
-e SHERWEB_CLIENT_ID=your-value \
-e SHERWEB_CLIENT_SECRET=your-value \
-e SHERWEB_SUBSCRIPTION_KEY=your-value \
-p 8080:8080 sherweb-mcp
```
## Available Domains
### Billing
Distributor payable charges for a billing period, and detail for an individual
charge. Sherweb returns charges only as a per-period collection, so both tools
take an optional `date` identifying the period.
### Catalog
Browse the products a given customer can be sold. Catalogs are per-customer in
Sherweb — there is no global product list — so `customerId` is required.
### Customers
List and look up customers, and read the receivable charges you bill them for a
billing period.
### Subscriptions
List a customer's subscriptions, get one subscription's details, and submit
quantity amendments. Amendments are **asynchronous**: submitting returns a
tracking ID, and `sherweb_subscriptions_amendment_status` reports the outcome.
## Interactive Subscription Card (MCP Apps)
`sherweb_subscriptions_get` renders as an interactive, read-only card in MCP
Apps hosts (Claude Desktop/web) showing the product, customer, status,
quantity, billing cycle, commitment/renewal dates, and fees; plain-JSON
behavior is unchanged in other hosts. The card is neutral by default and
brandable via `window.__BRAND__` injection or `MCP_BRAND_*` env vars
(`MCP_BRAND_NAME`, `MCP_BRAND_LOGO_URL`, `MCP_BRAND_PRIMARY_COLOR`,
`MCP_BRAND_ACCENT_COLOR`, `MCP_BRAND_BG`, `MCP_BRAND_TEXT`) — no rebuild
needed.
## Development
```bash
# Clone the repository
git clone https://github.com/WYRE-AI/sherweb-mcp.git
cd sherweb-mcp
# Install dependencies
npm install
# Build
npm run build
# Run tests
npm test
```
## Contributing
Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) if present, or open an issue to discuss changes.
## License
Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for details.