@userorbit/mcp
v0.1.3
Published
MCP server for the Userorbit API
Downloads
53
Maintainers
Readme
@userorbit/mcp
MCP server for the Userorbit API. Exposes 17 resource tools covering feedbacks, announcements, roadmaps, articles, subscribers, and more.
Authentication
Get your API key and team ID from Settings → API in Userorbit.
Setup
Claude Code
Add to .mcp.json in your project root:
{
"mcpServers": {
"userorbit": {
"command": "npx",
"args": ["@userorbit/mcp"],
"env": {
"USERORBIT_API_KEY": "your-api-key",
"USERORBIT_TEAM_ID": "your-team-id"
}
}
}
}Claude Desktop
Add to ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):
{
"mcpServers": {
"userorbit": {
"command": "npx",
"args": ["@userorbit/mcp"],
"env": {
"USERORBIT_API_KEY": "your-api-key",
"USERORBIT_TEAM_ID": "your-team-id"
}
}
}
}Cursor
Add to .cursor/mcp.json in your project root:
{
"mcpServers": {
"userorbit": {
"command": "npx",
"args": ["@userorbit/mcp"],
"env": {
"USERORBIT_API_KEY": "your-api-key",
"USERORBIT_TEAM_ID": "your-team-id"
}
}
}
}Windsurf
Add to ~/.codeium/windsurf/mcp_config.json:
{
"mcpServers": {
"userorbit": {
"command": "npx",
"args": ["@userorbit/mcp"],
"env": {
"USERORBIT_API_KEY": "your-api-key",
"USERORBIT_TEAM_ID": "your-team-id"
}
}
}
}VS Code (GitHub Copilot)
Add to .vscode/mcp.json in your project root:
{
"servers": {
"userorbit": {
"command": "npx",
"args": ["@userorbit/mcp"],
"env": {
"USERORBIT_API_KEY": "your-api-key",
"USERORBIT_TEAM_ID": "your-team-id"
}
}
}
}Tools
Each tool maps to a Userorbit API resource. Pass an action and params object.
| Tool | Actions |
|------|---------|
| userorbit_feedbacks | create, list, info, update, delete, archive, restore, vote |
| userorbit_feedback_boards | create, list, info, update, delete |
| userorbit_feedback_board_tags | create, list, update, delete |
| userorbit_feedback_comments | create, list, update, delete |
| userorbit_announcements | create, list, info, update, delete, search, archive, restore, pin, unpin |
| userorbit_announcement_comments | create, list, update, delete |
| userorbit_collections | create, list, info, update, delete |
| userorbit_roadmaps | create, list, info, update, delete, stages |
| userorbit_stages | create, list, info, update, delete |
| userorbit_topics | create, list, info, update, delete, count |
| userorbit_topic_comments | create, list, update, delete |
| userorbit_articles | create, list, info, update, delete, search, publish, unpublish, archive, revisions, restore |
| userorbit_article_collections | create, list, info, update, delete |
| userorbit_article_votes | info, create, delete |
| userorbit_tags | create, list, info, update, delete |
| userorbit_subscribers | create, list, update, delete, count, search |
| userorbit_projects | create, list, info, update, delete |
Environment Variables
| Variable | Required | Description |
|----------|----------|-------------|
| USERORBIT_API_KEY | Yes | API key from Settings → API |
| USERORBIT_TEAM_ID | No | Team ID, required for multi-team accounts |
Development
pnpm build # compile TypeScript
pnpm dev # watch mode