Agent skill

Maintainx Install Auth

by jeremylongshore in jeremylongshore/tons-of-skills-marketplace

Install and configure MaintainX REST API authentication. An agent skill from jeremylongshore/tons-of-skills-marketplace.

MITAuto-check: notesBackend & APIs

Install Maintainx Install Auth

skills CLI
$ npx skills add jeremylongshore/tons-of-skills-marketplace --skill maintainx-install-auth -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install jeremylongshore/tons-of-skills-marketplace maintainx-install-auth --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/jeremylongshore/tons-of-skills-marketplace.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/.curated/maintainx-install-auth .claude/skills/maintainx-install-auth && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
maintainx-install-auth
GitHub stars
2.8k
Token cost
~1.9k tokens
SKILL.md length
235 words
Files
1
Skills in repo
3,342
Repo updated
First seen
Licence
MIT

At a glance

Install and configure MaintainX REST API authentication. An agent skill from jeremylongshore/tons-of-skills-marketplace.

  • Works in 4 steps: Generate API Key → Configure Environment Variables → Create API Client Wrapper → …
  • Setting up a new MaintainX integration
  • SKILL.md covers Overview, Prerequisites, Instructions and Output, plus 5 more sections
  • Calls npx, curl and jq; reaches api.getmaintainx.com; needs MAINTAINX_API_KEY

What it does

Maintainx Install Auth is an agent skill from jeremylongshore/tons-of-skills-marketplace. Install and configure MaintainX REST API authentication. Use when setting up a new MaintainX integration, configuring API keys, or initializing MaintainX API access in your project. Trigger with phrases like "install maintainx", "setup maintainx", "maintainx auth", "configure maintainx API key", "maintainx credentials".

Its SKILL.md is about 1.9k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts. Compatibility notes: Designed for Claude Code

It sits in Backend & APIs, covering REST APIs. The repository describes itself as: Model-agnostic agent-skills platform with a harness-free canonical layer, verified adapters, and the ccpi package manager. Explore at tonsofskills.com. The licence is MIT.

When your agent uses it

  • Setting up a new MaintainX integration
  • Configuring API keys
  • Initializing MaintainX API access in your project
  • With phrases like install maintainx

Example prompts

  • “install maintainx”
  • “setup maintainx”
  • “maintainx auth”
  • “/maintainx-install-auth”

Requirements

  • Python 3
  • Node.js
  • A credential in MAINTAINX_API_KEY
  • Compatibility (from SKILL.md): Designed for Claude Code
  • Pre-approved tools (allowed-tools): Read, Write, Edit, Bash(npm:*), Bash(pip:*), Bash(curl:*), Grep

Workflow steps

4 steps, taken from the step headings in SKILL.md.

  1. Generate API Key
  2. Configure Environment Variables
  3. Create API Client Wrapper
  4. Verify Connection

What it can do on your machine

Read from SKILL.md and the folder at commit cfae287. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves these tools, so the agent can use them without asking each time:

    • Read
    • Write
    • Edit
    • Bash(npm:*)
    • Bash(pip:*)
    • Bash(curl:*)
    • Grep

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • npx
    • curl
    • jq

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Hosts in commands or code, which the agent is likely to contact:

    • api.getmaintainx.com

    Also links to:

    • maintainx.dev
    • help.getmaintainx.com

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names these keys or tokens, usually read from environment variables:

    • MAINTAINX_API_KEY

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

  • Compatibility

    Designed for Claude Code

    From compatibility in the SKILL.md frontmatter.

Context cost

Maintainx Install Auth loads about 1.9k tokens when it runs. Until then it costs about 86 tokens; SKILL.md has 235 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~86
When it runs · the whole SKILL.md, loaded when a task matches
~1.9k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check: notes

The automated check noted patterns worth knowing about, such as sudo or a known installer.

  • NoteMentions a .env fileSKILL.md:52
    # Or create .env file
  • NoteMentions a .env fileSKILL.md:53
    echo 'MAINTAINX_API_KEY=your-api-key' >> .env
  • NoteMentions a .env fileSKILL.md:237
    - Environment variable or `.env` file with API key configured

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from jeremylongshore/tons-of-skills-marketplace at commit cfae287, republished under its MIT licence (© jeremylongshore). 235 words, ~1,900 tokens.

Download SKILL.mdSave it as .claude/skills/maintainx-install-auth/SKILL.md (or your agent's skills folder).
name
maintainx-install-auth
description
Install and configure MaintainX REST API authentication. Use when setting up a new MaintainX integration, configuring API keys, or initializing MaintainX API access in your project. Trigger with phrases like "install maintainx", "setup maintainx", "maintainx auth", "configure maintainx API key", "maintainx credentials".
allowed-tools
Read, Write, Edit, Bash(npm:*), Bash(pip:*), Bash(curl:*), Grep
compatibility
Designed for Claude Code
version
1.11.0
license
MIT
author
Jeremy Longshore <jeremy@intentsolutions.io>
tags
saas, maintainx, api, authentication

MaintainX Install & Auth

Overview

Set up MaintainX REST API authentication and configure your development environment for CMMS integration.

Prerequisites

  • Node.js 18+ or Python 3.10+
  • MaintainX account with API access (Professional or Enterprise plan)
  • Admin access to generate API keys

Instructions

Step 1: Generate API Key
  1. Log into MaintainX at https://app.getmaintainx.com
  2. Navigate to Settings > Integrations
  3. Click New Key > Generate Key
  4. Copy and securely store your API key (shown only once)
Step 2: Configure Environment Variables
bash
# Set environment variable
export MAINTAINX_API_KEY="your-api-key-here"

# Or create .env file
echo 'MAINTAINX_API_KEY=your-api-key' >> .env

# For multi-organization tokens, also set:
export MAINTAINX_ORG_ID="your-organization-id"
Step 3: Create API Client Wrapper
typescript
// src/maintainx/client.ts
import axios, { AxiosInstance, AxiosError } from 'axios';

export class MaintainXClient {
  private client: AxiosInstance;
  private baseUrl = 'https://api.getmaintainx.com/v1';

  constructor(apiKey?: string, orgId?: string) {
    const key = apiKey || process.env.MAINTAINX_API_KEY;
    if (!key) {
      throw new Error('MAINTAINX_API_KEY is required');
    }

    this.client = axios.create({
      baseURL: this.baseUrl,
      headers: {
        'Authorization': `Bearer ${key}`,
        'Content-Type': 'application/json',
        ...(orgId && { 'X-Organization-Id': orgId }),
      },
    });

    this.client.interceptors.response.use(
      response => response,
      this.handleError
    );
  }

  private handleError(error: AxiosError) {
    if (error.response) {
      const { status, data } = error.response;
      console.error(`MaintainX API Error [${status}]:`, data);
    }
    throw error;
  }

  // Core API methods
  async getWorkOrders(params?: WorkOrderQueryParams) {
    return this.client.get('/workorders', { params });
  }

  async getWorkOrder(id: string) {
    return this.client.get(`/workorders/${id}`);
  }

  async createWorkOrder(data: CreateWorkOrderInput) {
    return this.client.post('/workorders', data);
  }

  async getAssets(params?: AssetQueryParams) {
    return this.client.get('/assets', { params });
  }

  async getLocations(params?: LocationQueryParams) {
    return this.client.get('/locations', { params });
  }

  async getUsers(params?: UserQueryParams) {
    return this.client.get('/users', { params });
  }
}

// Type definitions
interface WorkOrderQueryParams {
  cursor?: string;
  limit?: number;
  status?: 'OPEN' | 'IN_PROGRESS' | 'ON_HOLD' | 'DONE';
}

interface CreateWorkOrderInput {
  title: string;
  description?: string;
  priority?: 'NONE' | 'LOW' | 'MEDIUM' | 'HIGH';
  assignees?: string[];
  assetId?: string;
  locationId?: string;
  dueDate?: string;
}

interface AssetQueryParams {
  cursor?: string;
  limit?: number;
  locationId?: string;
}

interface LocationQueryParams {
  cursor?: string;
  limit?: number;
}

interface UserQueryParams {
  cursor?: string;
  limit?: number;
}
Step 4: Verify Connection
typescript
// test-connection.ts
import { MaintainXClient } from './maintainx/client';

async function testConnection() {
  const client = new MaintainXClient();

  try {
    const response = await client.getUsers({ limit: 1 });
    console.log('Connection successful!');
    console.log('Organization has users:', response.data.users.length > 0);
    return true;
  } catch (error) {
    console.error('Connection failed:', error);
    return false;
  }
}

testConnection();
bash
# Run test
npx ts-node test-connection.ts
Python Alternative
python
# maintainx_client.py
import os
import requests
from typing import Optional, Dict, Any

class MaintainXClient:
    BASE_URL = "https://api.getmaintainx.com/v1"

    def __init__(self, api_key: Optional[str] = None, org_id: Optional[str] = None):
        self.api_key = api_key or os.environ.get("MAINTAINX_API_KEY")
        if not self.api_key:
            raise ValueError("MAINTAINX_API_KEY is required")

        self.headers = {
            "Authorization": f"Bearer {self.api_key}",
            "Content-Type": "application/json",
        }
        if org_id:
            self.headers["X-Organization-Id"] = org_id

    def _request(self, method: str, endpoint: str, **kwargs) -> Dict[str, Any]:
        url = f"{self.BASE_URL}{endpoint}"
        response = requests.request(method, url, headers=self.headers, **kwargs)
        response.raise_for_status()
        return response.json()

    def get_work_orders(self, **params) -> Dict[str, Any]:
        return self._request("GET", "/workorders", params=params)

    def create_work_order(self, data: Dict[str, Any]) -> Dict[str, Any]:
        return self._request("POST", "/workorders", json=data)

    def get_assets(self, **params) -> Dict[str, Any]:
        return self._request("GET", "/assets", params=params)

    def get_locations(self, **params) -> Dict[str, Any]:
        return self._request("GET", "/locations", params=params)

# Test connection
if __name__ == "__main__":
    client = MaintainXClient()
    users = client._request("GET", "/users", params={"limit": 1})
    print("Connection successful!")
    print(f"Found {len(users.get('users', []))} users")

Output

  • Environment variable or .env file with API key configured
  • MaintainX client wrapper installed and configured
  • Successful connection verification output

Error Handling

ErrorCauseSolution
401 UnauthorizedInvalid or expired API keyGenerate new key in Settings > Integrations
403 ForbiddenInsufficient permissionsEnsure admin role or correct plan tier
404 Not FoundWrong base URL or endpointUse api.getmaintainx.com/v1
Network ErrorFirewall blocking HTTPSAllow outbound 443 to getmaintainx.com

Security Best Practices

  1. Never commit API keys to version control
  2. Use environment variables or secret managers
  3. Rotate keys periodically (every 90 days recommended)
  4. Use organization-specific keys for multi-tenant setups
  5. Limit key scope to required operations only

Resources

Next Steps

After successful auth, proceed to maintainx-hello-world for your first API call.

Examples

Quick test with curl:

bash
curl -s https://api.getmaintainx.com/v1/users?limit=1 \
  -H "Authorization: Bearer $MAINTAINX_API_KEY" | jq .

Multi-org setup (for contractors managing multiple facilities):

typescript
const clients = {
  plantA: new MaintainXClient(process.env.MAINTAINX_KEY_PLANT_A, 'org-plant-a'),
  plantB: new MaintainXClient(process.env.MAINTAINX_KEY_PLANT_B, 'org-plant-b'),
};
const orders = await clients.plantA.getWorkOrders({ status: 'OPEN' });

© jeremylongshore, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in skills/.curated/maintainx-install-auth of jeremylongshore/tons-of-skills-marketplace.

Open the folder on GitHubat commit cfae287

Compare with similar skills

Maintainx Install Auth next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Maintainx Install Auth compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Maintainx Install Auth this skilljeremylongshore/tons-of-skills-marketplace2.8k—~1.9kAutomated safety check: NotesMIT
Paperclippaperclipai/paperclip100k—~9.6kAutomated safety check: PassMIT
Nodejs Backend Patternsever-works/ever-works16218 repos~4kAutomated safety check: PassAGPL-3.0
OpenAPI to MCP Servermcp-use/mcp-use11k—~5.2kAutomated safety check: PassApache-2.0
Use Yaakmountain-loop/yaak19k—~1.9kAutomated safety check: PassMIT
API DesignerJeffallan/claude-skills12k1 repos~2kAutomated safety check: PassMIT

Similar skills

  • Paperclip

    paperclipai/paperclip

    Interact with the Paperclip control plane API for task coordination and governance.

    100k GitHub stars~9.6k tokensUpdated today
    Backend & APIsAuto-check passed
  • Nodejs Backend Patterns

    ever-works/ever-works

    Build production-ready Node.js backend services with Express/Fastify, implementing middleware patterns, error handling, authentication, database integration, and API design best practices.

    162 GitHub starsUsed in 18 repos~4k tokens
    Backend & APIsAuto-check passed
  • OpenAPI to MCP Server

    mcp-use/mcp-use

    Turns an OpenAPI or Swagger spec into an MCP server with the mcp-use TypeScript SDK, mapping each operation to a tool, wiring auth, testing and deploying.

    11k GitHub stars~5.2k tokensUpdated 2 days ago
    Backend & APIsAuto-check passed
  • Use Yaak

    mountain-loop/yaak

    A skill your agent uses when the user mentions Yaak, a Yaak workspace, or the yaak command, or asks to call, hit, or smoke test HTTP/REST endpoints, save or organize API requests for reuse or manual…

    19k GitHub stars~1.9k tokensUpdated today
    Backend & APIsAuto-check passed
  • API Designer

    Jeffallan/claude-skills

    Designs REST and GraphQL APIs from resource modeling to an OpenAPI 3.1 contract, with versioning, pagination and RFC 7807 error handling.

    12k GitHub starsUsed in 1 repo~2k tokens
    Backend & APIsAuto-check passed
  • Covers the RuView `wifi-densepose` command line binary, its Axum REST API and the WebAssembly builds for browsers and ESP32, for embedding or scripting RuView.

    97k GitHub stars~1.2k tokensUpdated today
    Backend & APIsAuto-check: notes

More from jeremylongshore/tons-of-skills-marketplace

All 3,342 skills in this repo
  • Performing Security Code Review

    jeremylongshore/tons-of-skills-marketplace

    Execute this skill enables AI assistant to conduct a security-focused code review using the security-agent plugin.

    2.8k GitHub starsUsed in 2 repos~1.3k tokens
    Auto-check: notes
  • Adapting Transfer Learning Models

    jeremylongshore/tons-of-skills-marketplace

    Build this skill automates the adaptation of pre-trained machine learning models using transfer learning techniques.

    2.8k GitHub stars~1.1k tokensUpdated today
    Auto-check passed
  • Agent Context Loader

    jeremylongshore/tons-of-skills-marketplace

    Execute proactive auto-loading: automatically detects and loads agents.md files.

    2.8k GitHub stars~1.1k tokensUpdated today
    Auto-check passed
  • Aggregating Performance Metrics

    jeremylongshore/tons-of-skills-marketplace

    Aggregate and centralize performance metrics from applications, systems, databases, caches, and services.

    2.8k GitHub stars~1.2k tokensUpdated today
    Auto-check passed
  • Analyzing Capacity Planning

    jeremylongshore/tons-of-skills-marketplace

    Execute this skill enables AI assistant to analyze capacity requirements and plan for future growth.

    2.8k GitHub stars~947 tokensUpdated today
    Auto-check passed
  • Analyzing Database Indexes

    jeremylongshore/tons-of-skills-marketplace

    Process use when you need to work with database indexing. An agent skill from jeremylongshore/tons-of-skills-marketplace.

    2.8k GitHub stars~2k tokensUpdated today
    Auto-check passed

Categories

Questions about Maintainx Install Auth

What does Maintainx Install Auth do?

Install and configure MaintainX REST API authentication. An agent skill from jeremylongshore/tons-of-skills-marketplace. Maintainx Install Auth is an agent skill from jeremylongshore/tons-of-skills-marketplace. Install and configure MaintainX REST API authentication.

When should I use Maintainx Install Auth?

Maintainx Install Auth fits situations like: setting up a new MaintainX integration; configuring API keys; initializing MaintainX API access in your project; with phrases like install maintainx.

How do I install Maintainx Install Auth in Claude Code?

Run `npx skills add jeremylongshore/tons-of-skills-marketplace --skill maintainx-install-auth -a claude-code`. Or copy the skill folder (skills/.curated/maintainx-install-auth in jeremylongshore/tons-of-skills-marketplace) into .claude/skills/maintainx-install-auth in your project. Claude Code loads it when a task matches its description.

How do I install Maintainx Install Auth in Codex?

Run `npx skills add jeremylongshore/tons-of-skills-marketplace --skill maintainx-install-auth -a codex`. Or copy the skill folder (skills/.curated/maintainx-install-auth in jeremylongshore/tons-of-skills-marketplace) into .agents/skills/maintainx-install-auth in your project. Codex loads it when a task matches its description.

Can I use Maintainx Install Auth in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add jeremylongshore/tons-of-skills-marketplace --skill maintainx-install-auth -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/maintainx-install-auth, .gemini/skills/maintainx-install-auth, .github/skills/maintainx-install-auth and .opencode/skills/maintainx-install-auth in your project.

What does Maintainx Install Auth need to run?

Going by SKILL.md and its folder, Maintainx Install Auth needs the command-line tools its instructions call (npx, curl and jq) and credentials named MAINTAINX_API_KEY. Our summary lists: Python 3; Node.js; A credential in MAINTAINX_API_KEY. Its frontmatter pre-approves these tools: Read, Write, Edit, Bash(npm:*), Bash(pip:*), Bash(curl:*), Grep. Compatibility (from SKILL.md): Designed for Claude Code.

Does Maintainx Install Auth access the network?

SKILL.md names 3 domains. In commands or code: api.getmaintainx.com; the agent is likely to contact it when it follows the instructions. As links in the text: maintainx.dev and help.getmaintainx.com. This is read from the text; nothing was executed.

Is Maintainx Install Auth safe to install?

Our automated static check of SKILL.md found notes only (mentions a .env file), nothing it rates as a warning. It is not a guarantee. Review the folder before installing.

What licence does Maintainx Install Auth use?

Maintainx Install Auth is published under the MIT licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Maintainx Install Auth use?

About 1.9k tokens (SKILL.md is roughly 7.6k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Maintainx Install Auth?

Skills that share tags, products or a category with Maintainx Install Auth: Paperclip (paperclipai/paperclip, 100k stars), Nodejs Backend Patterns (ever-works/ever-works, 162 stars), OpenAPI to MCP Server (mcp-use/mcp-use, 11k stars) and Use Yaak (mountain-loop/yaak, 19k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Maintainx Install Auth?

jeremylongshore (a GitHub user) maintains it in jeremylongshore/tons-of-skills-marketplace, which has 2,827 GitHub stars. The repository holds 3,342 skills in this directory. The repository was last updated on October 10, 2026.

Source: jeremylongshore/tons-of-skills-marketplace on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.