Skip to main content
Glama
mudbase-mcp-server

mudbase-mcp-server

mudbase-mcp-server

An MCP (Model Context Protocol) server that exposes Mudbase's database, storage, and search capabilities as tools for Claude Code, Claude Desktop, and any other MCP client.

Every request is authenticated with a Mudbase API key, so this connects your assistant directly to real data in your own Mudbase project: list and query collections, read and write documents, search across a project, and manage files in storage.

Requirements

  • A Mudbase account and project. If you don't have one yet, create one at www.mudbase.dev.

  • An API key for that project, generated from your project's API Keys settings.

  • Node.js 18 or newer (only needed to run npx; most MCP clients already bundle Node).

Related MCP server: Runar

Install

The npm package is not yet published. Install directly from GitHub while the package is in pre-release:

npm install -g github:themudhaxk/mudbase-mcp-server

Once installed, point your MCP client at the mudbase-mcp-server binary. When the package is published to npm you can switch to npx mudbase-mcp-server and it will update automatically.

Claude Code

Add this to your Claude Code MCP configuration:

{
  "mcpServers": {
    "mudbase": {
      "command": "mudbase-mcp-server",
      "env": { "MUDBASE_API_KEY": "ak_..." }
    }
  }
}

Replace ak_... with a real API key from your Mudbase project settings. Restart Claude Code (or reload MCP servers) and the mudbase_* tools become available.

Other MCP clients

Any client that can launch an MCP server over stdio works the same way: run npx mudbase-mcp-server as the command, with MUDBASE_API_KEY set in its environment. Consult your client's own docs for where to put the command / args / env fields; the shape above is the common one.

Configuration

Environment variable

Required

Description

MUDBASE_API_KEY

Yes

Your Mudbase project API key. The server refuses to start without it and prints a clear error explaining how to set it.

MUDBASE_BASE_URL

No

Override the API base URL (defaults to https://api.mudbase.dev). Only needed for a self-hosted or non-default deployment.

The API key is read from the environment only. It is never logged, never written to disk, and never hardcoded anywhere in this package.

Available tools

Collections (read-only schema access)

  • mudbase_list_collections: list every collection in a project, with each field's declared type.

  • mudbase_get_collection: get one collection's full field schema and permission settings.

Documents (collection data)

  • mudbase_list_documents: list documents in a collection, with pagination, sorting, and a JSON filter.

  • mudbase_get_document: fetch a single document by ID.

  • mudbase_create_document: create a new document.

  • mudbase_update_document: partially update an existing document.

  • mudbase_delete_document: permanently delete a document.

Search

  • mudbase_search_documents: full-text search across a project, optionally scoped to specific collections or fields.

Storage

  • mudbase_list_buckets: list the storage buckets in a project.

  • mudbase_list_files: list files in a bucket, with search and MIME-type filters.

  • mudbase_get_file: get metadata for a single stored file.

  • mudbase_upload_file: upload a file from base64-encoded content.

  • mudbase_delete_file: permanently delete a file.

  • mudbase_get_file_download_url: generate a time-limited signed download URL for a file.

Every tool is a thin, typed wrapper over one real Mudbase API endpoint; none of them add new business logic beyond request shaping and error normalization. mudbase_delete_document and mudbase_delete_file are marked destructive in their tool metadata so a client can prompt for confirmation before calling them.

How errors are reported

A failed API call (invalid API key, missing project, validation error, rate limit, and so on) never crashes the server or throws an unhandled exception. It comes back to the MCP client as a normal tool result with isError: true and a JSON body describing what went wrong, for example:

{
  "error": "Mudbase rejected this API key. Check that MUDBASE_API_KEY is a valid, active key with access to this project.",
  "status": 401,
  "code": "unauthorized"
}

Development

npm install
npm run build       # compile TypeScript to dist/
npm run dev          # run the server directly from source with tsx
npm test              # run the unit test suite
npm run typecheck      # tsc --noEmit
npm run lint             # eslint

License

MIT. Built by the Mudbase Team.

Available Tools

14 tools
mudbase_create_documentCreate a Mudbase documentA

Create a new document in a Mudbase collection. 'data' must match the collection's declared field schema (see mudbase_get_collection). Fires the collection's configured webhooks and triggers.

Inputs: data (required), projectId (required), collectionId (required).

mudbase_delete_documentDelete a Mudbase documentA
Destructive

Permanently delete a single document from a Mudbase collection. This cannot be undone.

Inputs: projectId (required), documentId (required), collectionId (required).

mudbase_delete_fileDelete a Mudbase fileA
Destructive

Permanently delete a file from a Mudbase storage bucket. This cannot be undone.

Inputs: fileId (required), bucketId (required), projectId (required).

mudbase_get_collectionGet a Mudbase collection's schemaA

Get the full field schema and permission settings for one collection in a Mudbase project.

Inputs: projectId (required), collectionId (required).

mudbase_get_documentGet a single Mudbase documentA

Fetch a single document by ID from a Mudbase collection.

Inputs: projectId (required), documentId (required), collectionId (required).

mudbase_get_fileGet Mudbase file metadataB

Get metadata (name, size, MIME type, visibility, timestamps) for a single stored file.

Inputs: fileId (required), bucketId (required), projectId (required).

mudbase_get_file_download_urlGet a signed download URL for a Mudbase fileA

Generate a time-limited signed URL to download a private or public file from Mudbase storage.

Inputs: fileId (required), bucketId (required), projectId (required), expiresIn.

mudbase_list_bucketsList Mudbase storage bucketsB

List the storage buckets configured in a Mudbase project.

Inputs: projectId (required), page, limit, search.

mudbase_list_collectionsList Mudbase collectionsA

List every collection (schema) defined in a Mudbase project, including each field's name and type. Call this before reading or writing documents to see what collections and fields actually exist.

Inputs: projectId (required).

mudbase_list_documentsList documents in a Mudbase collectionB

List documents in a Mudbase collection, with pagination, sorting, and an optional filter. 'filter' is a JSON-encoded object using Mudbase's structured query operators, e.g. '{"status":"active"}' or '{"age":{"$gte":18}}'.

Inputs: projectId (required), collectionId (required), page, sort, +2 more.

mudbase_list_filesList files in a Mudbase bucketA

List the files stored in one Mudbase storage bucket, with optional search and MIME type filter.

Inputs: bucketId (required), projectId (required), page, type, +2 more.

mudbase_search_documentsSearch across a Mudbase projectA

Full-text search across a Mudbase project's collections. Optionally scope to specific collections or fields.

Inputs: query (required), projectId (required), page, limit, +2 more.

mudbase_update_documentUpdate a Mudbase documentA

Partially update an existing document. Only the fields included in 'data' are changed; omitted fields are left as-is.

Inputs: data (required), projectId (required), documentId (required), collectionId (required).

mudbase_upload_fileUpload a file to Mudbase storageA

Upload a file to a Mudbase storage bucket. Provide the file content as a base64-encoded string. Best for small to moderate files (text, small images, JSON, documents) passed inline; not intended for very large binaries.

Inputs: bucketId (required), filename (required), projectId (required), contentBase64 (required), +2 more.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A3.9/5.0

    Scored across 14 tools

    Disambiguation5/5

    Each tool targets a distinct resource-action pairing: documents, collections, buckets, and files are cleanly separated. Even similar tools like list_documents and search_documents are distinguished by structured filtering versus full-text search.

    Naming Consistency5/5

    All tools follow a consistent mudbase_<verb>_<noun> pattern in snake_case, making the API predictable. The only compound name, get_file_download_url, still follows the same get_<resource>_<aspect> convention.

    Tool Count5/5

    14 tools is well within the ideal range and each tool covers a distinct operation across two coherent domains: document CRUD/search and file storage. No tool feels redundant or unnecessary.

    Completeness4/5

    Document CRUD, listing, filtering, and search are covered, along with file upload/list/get/delete and signed download URLs. Minor gaps exist around collection lifecycle management and file metadata updates, but agents can accomplish the core workflows without dead ends.

    Maintenance

    ActivityMaintained
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      C
      quality
      B
      maintenance
      Enables interaction with REMUS Jet databases through the MCP protocol, supporting local stdio and remote HTTP/SSE transports for database operations and project management.
      20
      AGPL 3.0
    • A
      license
      B
      quality
      C
      maintenance
      Provides AI agents with durable, searchable project memory, session notes, skills, and bounded context packs over MCP while leaving orchestration to the client.
      15
      MIT
    • A
      license
      A
      quality
      B
      maintenance
      Enables MCP clients to safely read, write, edit, search, and optionally run commands within one or more named project workspaces, while maintaining a work journal and tracking changes.
      19
      MIT
    • A
      license
      Not graded
      quality
      A
      maintenance
      Enables MCP clients to manage PocketBase databases by creating collections, performing record CRUD with pagination and relation expansion, handling user authentication, and backing up data.
      22 npm
      ISC