@adminforth/mcp 1.0.4 → 1.1.1

package/dist/types.d.ts

@@ -8,11 +8,55 @@ export interface McpAuthSecretResourceOptions {
     createdAtField: string;
     lastUsedAtField: string;
     lastUsedByAgentField: string;
+    readOnlyField: string;
+    /**
+     * Client ID Metadata Document URL of the MCP client connected through OAuth; empty for personal auth secrets.
+     * Setting it enables OAuth sign-in, which also needs adminPanelOrigin. Without it only auth secrets work.
+     */
+    oauthClientIdField?: string;
+}
+/** An MCP client allowed to connect through OAuth, as its Client ID Metadata Document describes it. */
+export interface McpOAuthClient {
+    clientId: string;
+    clientName: string;
+    redirectUris: string[];
+}
+export interface McpPageSize {
+    /** Rows get_resource_data returns when the client does not pass limit. */
+    default: number;
+    /** Most rows get_resource_data returns per call; larger limits are capped. */
+    max: number;
 }
 export interface PluginOptions extends PluginsCommonOptions {
     authSecretResource: McpAuthSecretResourceOptions;
-    /** Public origin of this AdminForth installation, without the AdminForth baseUrl path. */
+    /**
+     * Public origin of this AdminForth installation, without the AdminForth baseUrl path, e.g. https://example.com.
+     * The MCP server URL shown on the settings page, the OAuth issuer and resource URLs are built from it, so it must
+     * be the origin MCP clients connect to. Required with OAuth sign-in; without it the settings page shows the MCP URL
+     * of the address it was opened at.
+     */
     adminPanelOrigin?: string;
+    /**
+     * MCP clients resolved from this list instead of fetching their Client ID Metadata Document, so OAuth can be
+     * tried locally without a public https URL. Ignored when NODE_ENV is "production": there every client_id is
+     * fetched as a document with SSRF checks. Unlisted client_ids are fetched in development too.
+     */
+    devOAuthClients?: McpOAuthClient[];
+    /** Page size limits for get_resource_data, also quoted in the MCP instructions and skills. Defaults to 10 and 100. */
+    pageSize?: Partial<McpPageSize>;
+    /** How long a tool handler may run before the call fails with a timeout error. Defaults to 15000 ms. */
+    toolTimeoutMs?: number;
+    /**
+     * Tool calls an agent may make for one user request before it must ask the user to continue. Defaults to 10.
+     * MCP clients do not tell the server where a user request starts, so this is a rule in the MCP instructions,
+     * not a server-side limit.
+     */
+    toolCallsPerRequest?: number;
+    /**
+     * Expose only endpoints marked with `agent: { onlyReadsData: true }` to every auth secret.
+     * Without it, read-only mode is chosen per auth secret.
+     */
+    readOnly?: boolean;
 }
 export interface McpClientInfo {
     client: string;

package/dist/urls.d.ts

@@ -0,0 +1,13 @@
+export declare const MCP_PATH = "/mcp";
+/** Path prefix of AdminForth API endpoints, e.g. `/admin/adminapi/v1`. */
+export declare function adminApiPrefix(baseUrl: string): string;
+/**
+ * Public URLs of the plugin, built once from adminPanelOrigin: the settings page, OAuth metadata and the MCP server
+ * info must all name the same URL, because OAuth accepts tokens only for the exact MCP resource URL.
+ */
+export interface McpUrls {
+    apiUrl: string;
+    mcpUrl: string;
+    adminPanelUrl: string;
+}
+export declare function createMcpUrls(adminPanelOrigin: string, baseUrl: string): McpUrls;

package/dist/urls.js

@@ -0,0 +1,13 @@
+export const MCP_PATH = '/mcp';
+/** Path prefix of AdminForth API endpoints, e.g. `/admin/adminapi/v1`. */
+export function adminApiPrefix(baseUrl) {
+    return `${baseUrl}/adminapi/v1`;
+}
+export function createMcpUrls(adminPanelOrigin, baseUrl) {
+    const apiUrl = new URL(adminApiPrefix(baseUrl), adminPanelOrigin).href;
+    return {
+        apiUrl,
+        mcpUrl: `${apiUrl}${MCP_PATH}`,
+        adminPanelUrl: new URL(baseUrl || '/', adminPanelOrigin).href,
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/mcp",
-  "version": "1.0.4",
+  "version": "1.1.1",
   "description": "Expose AdminForth APIs as an authenticated MCP server",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -41,13 +41,13 @@
   "license": "MIT",
   "devDependencies": {
     "@types/node": "latest",
-    "adminforth": "^3.20.0",
+    "adminforth": "^3.32.0",
     "semantic-release": "^24.2.1",
     "semantic-release-slack-bot": "^4.0.2",
     "typescript": "^5.7.3"
   },
   "peerDependencies": {
-    "adminforth": "^3.22.0"
+    "adminforth": "^3.32.0"
   },
   "release": {
     "plugins": [
@@ -73,5 +73,8 @@
         "prerelease": true
       }
     ]
+  },
+  "dependencies": {
+    "yaml": "^2.9.1"
   }
 }