Mirra
Build

Getting Started

This guide walks you through setting up your developer account and creating your first resource or script on the Mirra Store. You will learn how to access the developer dashboard, configure your profile, choose the right integration type, and publish your first integration to the marketplace.

By the end of this guide, you will have a complete developer profile and understand the workflow for creating and publishing integrations.

Prerequisites

Before you begin, ensure you have the following:

  • Mirra Store account - An active account on the Mirra Store platform
  • Developer access - Developer permissions enabled on your account (contact support if needed)
  • Integration to publish - An API to integrate (for resources) or code to automate (for scripts)
  • Basic technical knowledge - Understanding of APIs (for resources) or programming (for scripts)

Step 1: Access the developer dashboard

The developer dashboard is your workspace for creating and managing integrations. You can access it through the profile menu or by navigating directly to the URL.

Accessing the dashboard

  1. Log in to your Mirra Store account
  2. Click on your profile menu in the top-right corner
  3. Select "Developer Dashboard" from the dropdown menu
  4. Alternatively, navigate directly to /developer in your browser

Dashboard overview

After accessing the dashboard, you will see five main sections:

  • Resources - Create and manage API integrations
  • Scripts - Write and test automation scripts
  • Reviews - View and respond to user feedback
  • Profile - Configure your public developer identity
  • Analytics - Track usage and revenue metrics (coming soon)

The dashboard provides a centralized interface for all your development activities on the Mirra Store.

Step 2: Set up your developer profile

Your developer profile is your public identity on the marketplace. A complete profile builds trust with users and increases the visibility of your integrations.

  1. Click "Profile" in the sidebar navigation
  2. Click the "Edit Profile" button
  3. The profile editor opens with fields for your information

Completing your profile

Basic Information

  • Display Name (required): Your name or company name
  • Bio: Describe your expertise (max 500 characters)
  • Website: Link to your portfolio or company site

Your display name will appear on all your published resources and scripts. Choose something professional and recognizable.

Avatar

  • Enter a URL to your profile picture
  • Recommended size: 400x400px
  • Supports JPG, PNG, and GIF formats
  • Preview updates in real-time

You must host your avatar image externally. Use services like Imgur, Cloudinary, or your own website.

Connect your social profiles to build credibility:

  • GitHub: Link to your repositories
  • Twitter: Share updates and engage
  • Discord: Community support
  • LinkedIn: Professional networking

All fields are optional but recommended.

Saving your profile

Click "Save Changes" when you have completed all fields. The system validates your information and displays a success notification. You are then redirected to your profile view where you can see how your profile appears to users.

Success criteria: Your profile is complete when you have added a display name, bio, avatar URL, and at least one social link.

Step 3: Choose what to build

The developer portal supports two main integration types: resources (API integrations) and scripts (automation code). Choose the type that best fits your use case.

Creating a resource

Create a resource if you have an API to integrate or want to expose external services to Mirra users.

Choose resources when you have:

  • An API endpoint to integrate (REST, GraphQL, or other HTTP-based API)
  • External services to expose (weather data, databases, payment gateways)
  • OpenAPI 3.0 documentation for your API
  • Authentication requirements (API key, OAuth2, Bearer token, or Basic Auth)

Example use cases:

  • Weather API integration providing forecast data
  • Database connector for PostgreSQL or MongoDB
  • Payment gateway integration (Stripe, PayPal)
  • AI service integration (OpenAI, Anthropic)

See Creating Resources for detailed instructions.

Creating a script

Create a script if you want to automate tasks, process data, or implement custom business logic.

Choose scripts when you need to:

  • Automate repetitive tasks or workflows
  • Process or transform data between services
  • Combine multiple APIs into a single operation
  • Implement custom business logic not available in existing services

Example use cases:

  • Data processor that transforms JSON between formats
  • Email automation that sends notifications based on conditions
  • Report generator that aggregates data from multiple sources
  • Workflow orchestrator that coordinates multiple service calls

See Creating Scripts for detailed instructions.

Step 4: Create your first resource

If you are creating a resource, follow these steps to build and publish your API integration.

  1. Click "Resources" in the sidebar navigation
  2. Click the "Create Resource" button
  3. Alternatively, use the keyboard shortcut Ctrl+N

The resource editor opens with fields for your API configuration.

Filling in basic information

Provide essential metadata about your resource:

{
  "name": "Weather API",
  "description": "Real-time weather data for any location worldwide",
  "category": "Data & APIs",
  "tags": ["weather", "forecast", "climate", "meteorology"]
}

Field requirements:

  • Name - Unique, descriptive name (3-50 characters)
  • Description - Clear explanation of what your API does (10-500 characters)
  • Category - Select from predefined categories (Data & APIs, AI & ML, etc.)
  • Tags - Keywords for discoverability (3-10 tags recommended)

Adding OpenAPI specification

Provide your API specification in OpenAPI 3.0 format. The platform validates your specification and generates documentation automatically.

Required components:

  • Info - API metadata including title, version, and description
  • Servers - Base URLs for your API endpoints
  • Paths - Endpoint definitions with HTTP methods, parameters, and responses
  • Components - Reusable schemas, security definitions, and response objects

See the example OpenAPI specification for a complete working example.

Configuring authentication

Choose the authentication method that matches your API:

  • None - Public API with no authentication required
  • API Key - Users provide their own API key (header, query, or cookie)
  • OAuth2 - OAuth 2.0 authorization flow with token exchange
  • Basic Auth - Username and password authentication
  • Bearer Token - JWT or other bearer token authentication

The platform handles credential storage and injection automatically based on your configuration.

Setting pricing

Choose your pricing model based on your business strategy:

  • Free - No cost to users (recommended for building initial user base)
  • Pay-per-call - $0.001 - $1.00 per API request (usage-based pricing)
  • Subscription - $5 - $500 per month (unlimited access)

You can change your pricing model after publishing, but price increases may affect existing users.

Testing and publishing

  1. Click "Save Draft" to save your configuration
  2. Test all endpoints using the built-in testing tools
  3. Verify authentication works correctly with test credentials
  4. Review all configuration and documentation
  5. Click "Publish" when ready to make your resource live

Your resource is now live in the marketplace! Users can discover, install, and use it through their agents.

Success criteria: Your resource is successfully published when it appears in the marketplace and users can install it.

Step 5: Create your first script

If you are creating a script, follow these steps to build and publish your automation code.

  1. Click "Scripts" in the sidebar navigation
  2. Click the "Create Script" button
  3. Alternatively, use the keyboard shortcut Ctrl+Shift+N

The script editor opens with the Monaco code editor and configuration fields.

Filling in basic information

Provide essential metadata about your script:

{
  "name": "Text Analyzer",
  "description": "Analyzes text and provides detailed statistics including word count, sentence count, and character count",
  "runtime": "nodejs18"
}

Field requirements:

  • Name - Unique, descriptive name (3-50 characters)
  • Description - Clear explanation of what your script does (10-500 characters)
  • Runtime - Choose nodejs18 (JavaScript/TypeScript) or python3.11 (Python)

Writing your code

Use the Monaco code editor with full IDE features including syntax highlighting, autocomplete, and error detection.

Node.js example:

async function execute(params) {
  // Validate input
  if (!params.text) {
    throw new Error('text parameter is required');
  }
 
  // Process text
  const words = params.text.split(/\s+/).filter(w => w.length > 0);
  const sentences = params.text.split(/[.!?]+/).filter(s => s.trim());
 
  // Return results
  return {
    wordCount: words.length,
    sentenceCount: sentences.length,
    characterCount: params.text.length,
    averageWordLength: words.reduce((sum, w) => sum + w.length, 0) / words.length
  };
}
 
module.exports = { execute };

Python example:

def execute(params):
    # Validate input
    if 'text' not in params:
        raise ValueError('text parameter is required')
    
    # Process text
    text = params['text']
    words = [w for w in text.split() if w]
    sentences = [s.strip() for s in text.split('.') if s.strip()]
    
    # Return results
    return {
        'wordCount': len(words),
        'sentenceCount': len(sentences),
        'characterCount': len(text),
        'averageWordLength': sum(len(w) for w in words) / len(words) if words else 0
    }

Your function must be named execute and accept a params object. Return a JSON-serializable object with your results.

Configuring execution limits

Set resource limits to control costs and prevent abuse:

  • Timeout - Maximum execution time (1-300 seconds, default: 30)
  • Memory - RAM limit (128-2048 MB, default: 256)
  • Max Cost - Cost limit per execution (default: $0.10)
  • Max Executions - Daily execution limit (default: 1000)

These limits protect both you and your users from unexpected costs.

Testing your script

  1. Click the "Test" button in the editor toolbar
  2. Provide test parameters in JSON format:
{
  "text": "Hello world! This is a test. Testing is important."
}
  1. View execution results and verify correctness
  2. Check execution logs for errors or warnings
  3. Test with edge cases (empty input, very long input, special characters)

Publishing your script

  1. Click "Save Draft" to save your code
  2. Test thoroughly with various inputs and edge cases
  3. Review all configuration and documentation
  4. Click "Publish" when ready to make your script live

Your script is now live in the marketplace! Users can execute it through their agents.

Success criteria: Your script is successfully published when it appears in the marketplace and users can execute it.

Step 6: Monitor and engage

After publishing your integration, monitor its performance and engage with users to build a successful presence in the marketplace.

Viewing statistics

Check your developer profile to track key metrics:

  • Total users - Number of users who have installed your integration
  • API calls / executions - Total usage volume over time
  • Revenue earned - Total earnings from paid integrations
  • Average rating - User satisfaction score (1-5 stars)
  • Total reviews - Number of user reviews and feedback

The analytics dashboard (coming soon) will provide detailed charts and trends for these metrics.

Responding to reviews

Engage with your users through the reviews system:

  1. Navigate to "Reviews" in the sidebar
  2. View user feedback, ratings, and comments
  3. Reply to reviews professionally and promptly
  4. Address issues and questions in your responses
  5. Thank users for positive feedback

Professional engagement with reviews builds trust and improves your reputation in the marketplace.

Updating your integration

Continuously improve your integration based on user feedback and changing requirements:

  • Fix bugs - Address reported issues quickly to maintain user satisfaction
  • Add features - Implement requested features and enhancements
  • Improve documentation - Update descriptions and examples based on user questions
  • Optimize performance - Reduce latency and improve reliability

Use version control to track changes and roll back if needed.

Keyboard shortcuts

The developer portal includes keyboard shortcuts to speed up your workflow. See the complete Keyboard Shortcuts guide for all available shortcuts.

Common shortcuts:

  • Ctrl+N - Create new resource
  • Ctrl+Shift+N - Create new script
  • Ctrl+S - Save current work
  • Ctrl+/ - Toggle code comment
  • Ctrl+F - Find in code editor

Troubleshooting

Common issues and solutions when getting started with the developer portal.

Cannot access developer dashboard

Problem: The developer dashboard link is not visible or returns an error.

Solution: Contact support to enable developer access on your account. Developer access is required to create and publish integrations.

OpenAPI specification not validating

Problem: Your OpenAPI specification fails validation when creating a resource.

Solution: Use an OpenAPI validator like Swagger Editor to check your specification for errors. Common issues include missing required fields, invalid schema references, and incorrect version format.

Script execution timeout

Problem: Your script exceeds the execution time limit during testing.

Solution: Optimize your code to reduce execution time, or contact support to request higher limits for your account. Consider breaking complex operations into smaller steps.

Avatar image not displaying

Problem: Your profile avatar does not appear after saving.

Solution: Ensure your image URL is publicly accessible and uses HTTPS. The image must be hosted externally (not on the Mirra platform). Recommended size is 400x400 pixels.

Next steps

Now that you have set up your developer account and understand the workflow, explore these detailed guides:

See also

Previous

Developer Portal Introduction

Next

Creating Scripts (Portal)

On this page

PrerequisitesStep 1: Access the developer dashboardAccessing the dashboardDashboard overviewStep 2: Set up your developer profileNavigating to profile settingsCompleting your profileBasic InformationAvatarSocial LinksSaving your profileStep 3: Choose what to buildCreating a resourceCreating a scriptStep 4: Create your first resourceNavigating to resourcesFilling in basic informationAdding OpenAPI specificationConfiguring authenticationSetting pricingTesting and publishingStep 5: Create your first scriptNavigating to scriptsFilling in basic informationWriting your codeConfiguring execution limitsTesting your scriptPublishing your scriptStep 6: Monitor and engageViewing statisticsResponding to reviewsUpdating your integrationKeyboard shortcutsTroubleshootingCannot access developer dashboardOpenAPI specification not validatingScript execution timeoutAvatar image not displayingNext stepsSee also