@outseta/admin-mcp-server
v0.0.4
Published
Model Context Protocol (MCP) server for Outseta administration - enables AI assistants to manage your Outseta account through natural language
Readme
Outseta Admin MCP Server
A Model Context Protocol (MCP) server for interacting with your Outseta account. This server provides AI assistants with the ability to manage your Outseta account through natural language commands.
What You Can Do
This MCP server enables AI assistants to help you with common Outseta administrative tasks:
Account & People
Manage accounts & people:
- "Register a new account for Acme Corp"
- "Add [email protected] to the Basic plan"
- "Create a new person 'Jane Doe' ([email protected])"
- "Add Sarah Johnson as a team member to the Acme Corp"
- "Update the primary contact for Acme Corp"
Explore accounts & people:
- "How many people are associated with Acme Corp?"
- "List all accounts created this month"
- "Who has been added this week?"
- "What accounts are trialing at the moment?"
Billing Plans
Manage billing plans & plan families:
- "Create a new monthly plan called 'Starter' for $29/month, $199/year"
- "Add a 'Pro' plan"
- "Help me create plans for a course business"
- "Let's add SaaS style plans"
- "Create a plan family for my course business"
- "Set up plan families for different product lines"
Explore billing plans & plan families:
- "What are my paid plans?"
- "What is the price of my Pro plan?"
- "List all plan families"
- "Show me all plans in the 'SaaS' plan family"
Subscriptions
Preview & change subscriptions:
- "What would happen if I upgrade account Acme Corp to annual billing?"
- "Preview the cost changes if I switch Acme Corp to the Pro plan"
- "Upgrade Acme Corp to the Pro plan starting immediately"
Explore subscriptions:
- "Show me all active subscriptions"
- "Show me failed payments this week"
- "List accounts that are currently on trials"
Email Lists
Manage email lists & subscriptions:
- "I need a newsletter"
- "Let's add a Product Updates list with double opt-in"
- "Add [email protected] to Product Updates"
- "Create an internal list for team announcements"
Explore email lists & subscribers:
- "What email lists do I have"
- "Who's subscribed to Product Updates?"
- "List all subscribers to my newsletter"
- "How many people are on each of my email lists?"
Integration with AI Assistants
This server integrates with MCP-compatible AI assistants to enable natural language management of your Outseta account. The AI assistant will automatically select the appropriate tools based on your requests, handle parameter validation and error checking, and prompt for confirmation before performing destructive operations.
Prerequisites & Requirements
Before setting up the MCP server, ensure you have:
- Node.js (version 18 or higher)
- An active Outseta account with admin access
- Outseta API credentials (API key and secret)
- MCP-compatible AI assistant (Cursor, Claude Desktop, or similar)
Getting Your API Credentials
To use this MCP server, you'll need to obtain API credentials from your Outseta account:
- Log into your Outseta account
- Go to Settings > Integrations > API Keys
- Click Add API Keys
- Create a new API key with appropriate permissions
- Note down your:
- Subdomain (e.g., if your Outseta URL is
yourcompany.outseta.com, your subdomain isyourcompany) - API Key
- API Secret
- Subdomain (e.g., if your Outseta URL is
Important: Keep these credentials secure
Using the MCP Server with Cursor
- In Cursor, open your settings (Cmd/Ctrl + ,)
- Search for "MCP" or go to Extensions > MCP
- Add a new MCP server configuration:
{ "name": "outseta-admin", "command": "npx", "args": ["-y", "@outseta/admin-mcp-server"], "env": { "OUTSETA_SUBDOMAIN": "your-subdomain", "OUTSETA_API_KEY": "your-api-key", "OUTSETA_API_SECRET": "your-api-secret" } } - Save the configuration and restart Cursor
- The Outseta tools will now be available in Cursor's AI assistant
For multiple accounts in Cursor, you can add multiple server configurations in the MCP settings:
[
{
"name": "outseta-production",
"command": "npx",
"args": ["-y", "@outseta/admin-mcp-server"],
"env": {
"OUTSETA_SUBDOMAIN": "yourcompany",
"OUTSETA_API_KEY": "your-production-api-key",
"OUTSETA_API_SECRET": "your-production-api-secret"
}
},
{
"name": "outseta-staging",
"command": "npx",
"args": ["-y", "@outseta/admin-mcp-server"],
"env": {
"OUTSETA_SUBDOMAIN": "yourcompany-staging",
"OUTSETA_API_KEY": "your-staging-api-key",
"OUTSETA_API_SECRET": "your-staging-api-secret"
}
}
]Using the MCP Server with Claude Desktop
- Open Claude Desktop's configuration file:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
- macOS:
- Add the MCP server configuration:
{ "mcpServers": { "outseta-admin": { "command": "npx", "args": ["-y", "@outseta/admin-mcp-server"], "env": { "OUTSETA_SUBDOMAIN": "your-subdomain", "OUTSETA_API_KEY": "your-api-key", "OUTSETA_API_SECRET": "your-api-secret" } } } } - Save the configuration and restart Claude Desktop
- The Outseta tools will now be available in Claude Desktop
Connecting to Multiple Outseta Accounts
You can configure multiple instances of the MCP server to connect to different Outseta accounts simultaneously. This is useful when you manage multiple Outseta accounts or want to separate different environments (production, staging, etc.).
Example Configuration for Multiple Accounts
In Claude Desktop's configuration file, you can add multiple server entries:
{
"mcpServers": {
"outseta-client-x: {
"command": "npx",
"args": ["-y", "@outseta/admin-mcp-server"],
"env": {
"OUTSETA_SUBDOMAIN": "client-x-subdomain",
"OUTSETA_API_KEY": "your-production-api-key",
"OUTSETA_API_SECRET": "your-production-api-secret"
}
},
"outseta-client-y": {
"command": "npx",
"args": ["-y", "@outseta/admin-mcp-server"],
"env": {
"OUTSETA_SUBDOMAIN": "client-y-subdomain",
"OUTSETA_API_KEY": "your-staging-api-key",
"OUTSETA_API_SECRET": "your-staging-api-secret"
}
}
}
}How Multiple Instances Work
- Each instance runs independently with its own API credentials
- You can identify which account you're working with by mentioning the distinct name, ie. "How many people are associated with client-x in Outseta?"
- All commands will be executed against the account specified in that instance's configuration
- The AI assistant will have access to tools from all configured instances
Best Practices for Multiple Accounts
- Use descriptive names: Choose server names that clearly identify the account or environment
- Separate credentials: Use different API keys for each account for better security and access control
- Document your setup: Keep track of which server connects to which account
- Test configurations: Verify each instance works correctly after setup
Security Considerations
When using this MCP server, keep the following security practices in mind:
API Credential Security
- Never commit API credentials to version control systems
- Store credentials securely using environment variables
- Regularly rotate your API keys as part of good security hygiene
- Use the minimum required permissions for your API keys
Data Privacy
- The MCP server only accesses data you explicitly request through AI commands
- All API calls are made directly from your local environment to Outseta
- No data is stored persistently by the MCP server
- Review AI commands before confirming destructive operations
Access Control
- Only install this server in trusted environments
- Be cautious when sharing MCP configurations that include credentials
- Create keys specifically for the MCP server
Contributing
Interested in contributing? See CONTRIBUTING.md for development setup and guidelines.
License
ISC
