MCPResource Class API Reference

---

title: "MCPResource Class API Reference" description: "Complete API reference for the MCPResource base class in mcp-framework — expose data sources, files, and dynamic content to AI models via URI-based addressing." order: 3 keywords: ["MCPResource", "MCP resource", "mcp-framework resource", "resource API", "URI template", "data source"] date: "2026-04-01"

Overview

Resources are ideal for exposing files, database records, configuration data, API responses, or any content an AI model might need to read.

Class Signature

import { MCPResource } from "mcp-framework";

class MyResource extends MCPResource {
  uri = "myapp://config";
  name = "Application Configuration";
  description = "Returns the current application configuration";
  mimeType = "application/json";

  async read(): Promise<string> {
    const config = await loadConfig();
    return JSON.stringify(config);
  }
}

export default MyResource;

Properties

Methods

read(uri?)

Returns the resource content as a string.

async read(uri?: string): Promise<string>

Parameters:

• uri (optional) — The full URI that was requested. For template resources, use this to extract parameters.

Returns: String content of the resource.

Static Resources

Static resources have a fixed URI and return the same type of content on each read:

import { MCPResource } from "mcp-framework";

class SystemInfoResource extends MCPResource {
  uri = "system://info";
  name = "System Information";
  description = "Returns current system information including OS, memory, and uptime";
  mimeType = "application/json";

  async read() {
    return JSON.stringify({
      platform: process.platform,
      nodeVersion: process.version,
      memoryUsage: process.memoryUsage(),
      uptime: process.uptime(),
    });
  }
}

export default SystemInfoResource;

Dynamic Resources (URI Templates)

Dynamic resources use URI templates with {parameter} placeholders:

import { MCPResource } from "mcp-framework";

class UserResource extends MCPResource {
  uri = "db://users/{userId}";
  name = "User Record";
  description = "Returns user data by ID from the database";
  mimeType = "application/json";

  async read(uri?: string) {
    // Extract userId from the URI
    const userId = uri?.match(/db:\/\/users\/(.+)/)?.[1];
    if (!userId) throw new Error("User ID is required");

    const user = await db.users.findById(userId);
    if (!user) throw new Error(`User not found: ${userId}`);

    return JSON.stringify(user);
  }
}

export default UserResource;

File Placement

Resources are auto-discovered from the src/resources/ directory:

Common Patterns

File Content Resource

import { MCPResource } from "mcp-framework";
import fs from "fs/promises";

class FileResource extends MCPResource {
  uri = "file://project/{path}";
  name = "Project File";
  description = "Read files from the project directory";
  mimeType = "text/plain";

  async read(uri?: string) {
    const filePath = uri?.replace("file://project/", "") || "";
    const content = await fs.readFile(filePath, "utf-8");
    return content;
  }
}

export default FileResource;

Database Query Resource

import { MCPResource } from "mcp-framework";

class RecentOrdersResource extends MCPResource {
  uri = "db://orders/recent";
  name = "Recent Orders";
  description = "Returns the 50 most recent orders with customer and product details";
  mimeType = "application/json";

  async read() {
    const orders = await db.orders
      .find()
      .sort({ createdAt: -1 })
      .limit(50)
      .populate("customer product");

    return JSON.stringify(orders);
  }
}

export default RecentOrdersResource;

CLI Scaffolding

Generate a new resource with the CLI:

npx mcp-framework add resource MyResource

This creates src/resources/MyResource.ts with the correct boilerplate. See the CLI Reference for details.