Refactor and readme fixes; Check api key on startup (#12)

Author: danixeee

.vscode/mcp.json

@@ -0,0 +1,15 @@
+{
+	"servers": {
+		"plainly": {
+			"command": "yarn",
+			"args": [
+				"dlx",
+				"@plainly-videos/mcp-server@latest",
+				"mcp-server"
+			],
+			"env": {
+				"PLAINLY_API_KEY": "<PLAINLY_API_KEY>"
+			}
+		}
+	}
+}

README.md

@@ -30,8 +30,8 @@ Implementation of MCP server for [Plainly](https://www.plainlyvideos.com/) in No
 {
   "servers": {
     "plainly": {
-      "command": "npx",
-      "args": ["-y", "@plainly-videos/mcp-server@latest"],
+      "command": "yarn",
+      "args": ["dlx", "@plainly-videos/mcp-server@latest", "mcp-server"],
       "env": {
         "PLAINLY_API_KEY": "<PLAINLY_API_KEY>"
       }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plainly-videos/mcp-server",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "MCP server for Plainly Videos that allows browsing designs and projects, as well as rendering videos.",
   "license": "MIT",
   "author": "PlainlyVideos <[email protected]>",
@@ -19,8 +19,15 @@
     "mcp-server",
     "modelcontextprotocol",
     "aftereffects",
+    "adobe-after-effects",
     "video-api",
-    "video-automation"
+    "video-automation",
+    "video-processing",
+    "video-rendering",
+    "automation",
+    "api",
+    "javascript",
+    "typescript"
   ],
   "bin": "dist/index.js",
   "files": [

src/axiosConfig.ts

@@ -1,5 +1,6 @@
 import axios, { AxiosInstance } from "axios";
 import env from "./env";
+import { PACKAGE_NAME, PACKAGE_VERSION } from "./contants";
 
 export function createAxiosInstance(config?: {
   baseUrl?: string;
@@ -15,7 +16,7 @@ export function createAxiosInstance(config?: {
       password: "",
     },
     headers: {
-      "User-Agent": "plainly-mcp-server/1.0",
+      "User-Agent": `${PACKAGE_NAME}/${PACKAGE_VERSION}`,
     },
     timeout: 10000,
   });

src/contants.ts

@@ -0,0 +1,4 @@
+import { name, version } from "../package.json";
+
+export const PACKAGE_NAME = name;
+export const PACKAGE_VERSION = version;

src/index.ts

@@ -2,13 +2,18 @@
 
 import { PlainlyMcpServer } from "./server";
 import env from "./env";
+import { isValidApiKey } from "./sdk";
 
 // Validate required environment variables
-if (!env.PLAINLY_API_KEY || !env.PLAINLY_API_URL) {
-  console.error(
-    "Please set PLAINLY_API_KEY and PLAINLY_API_URL environment variables."
-  );
+if (!env.PLAINLY_API_KEY) {
+  console.error("\nERROR: PLAINLY_API_KEY environment variable is required.\n");
   process.exit(1);
+} else {
+  // Test API key
+  if (!(await isValidApiKey())) {
+    console.error("\nERROR: Invalid PLAINLY_API_KEY.\n");
+    process.exit(1);
+  }
 }
 
 const server = new PlainlyMcpServer();

src/sdk/api/checkApiKey.ts

@@ -0,0 +1,12 @@
+import { createAxiosInstance } from "../../axiosConfig";
+
+const api = createAxiosInstance();
+
+export const isValidApiKey = async (): Promise<boolean> => {
+  try {
+    await api.get(`/api/v2/me`);
+    return true;
+  } catch {
+    return false;
+  }
+};

src/sdk/api/index.ts

@@ -1,3 +1,4 @@
+export * from "./checkApiKey";
 export * from "./listRenderableItems";
 export * from "./getRenderableItemDetails";
 export * from "./renderItem";

src/sdk/api/renderItem.ts

@@ -1,9 +1,7 @@
 import { AxiosResponse } from "axios";
 import { createAxiosInstance } from "../../axiosConfig";
 import { ProjectRenderDto, Render } from "../types";
-
-// get name from package.json
-import { name } from "../../../package.json";
+import { PACKAGE_NAME } from "../../contants";
 
 const api = createAxiosInstance();
 
@@ -24,7 +22,7 @@ export const renderItem = async (params: RenderParams): Promise<Render> => {
     templateId: params.templateVariantId,
     parameters: params.parameters,
     attributes: {
-      [name]: "true",
+      [PACKAGE_NAME]: "true",
     },
   });
 

src/server.ts

@@ -6,15 +6,16 @@ import {
   registerRenderItem,
   registerCheckRenderStatus,
 } from "./tools";
+import { PACKAGE_NAME, PACKAGE_VERSION } from "./contants";
 
 export class PlainlyMcpServer {
   server: McpServer;
   transport: StdioServerTransport;
 
   constructor() {
     this.server = new McpServer({
-      name: "plainly-mcp-server",
-      version: "1.0.0",
+      name: PACKAGE_NAME,
+      version: PACKAGE_VERSION,
     });
     this.transport = new StdioServerTransport();