eslint magic

eslint.config.js

@@ -8,10 +8,19 @@ import tsPlugin from "typescript-eslint";
 
 /** @type {import('eslint').Linter.Config[]} */
 export default [
+  {
+    ignores: [
+      "node_modules/**",
+      "dist/**",
+      "build/**",
+      "coverage/**",
+      "*.min.js",
+      "src/gen/**", // Exclude generated API files
+    ],
+  },
   securityPlugin.configs.recommended,
   {
-    files: ["**/*.ts"],
+    files: ["src/**/*.ts"],
-    ignores: ["src/gen/**"],
   },
   {
     languageOptions: { globals: globals.node },
@@ -60,16 +69,7 @@ export default [
       "import/order": [
         "error",
         {
-          groups: [
+          groups: ["builtin", "external", "internal", "parent", "sibling", "index", "object", "type"],
-            "builtin",
-            "external",
-            "internal",
-            "parent",
-            "sibling",
-            "index",
-            "object",
-            "type",
-          ],
           "newlines-between": "always",
           alphabetize: {
             order: "asc",

src/outline.ts

@@ -7,11 +7,7 @@ import { registerDocumentTools } from "./tools/document";
 
 import type { Logger } from "pino";
 
-const createOutlineClient = (
+const createOutlineClient = (baseUrl: string, apiKey: string, logger: Logger) => {
-  baseUrl: string,
-  apiKey: string,
-  logger: Logger
-) => {
   const config = new Configuration({
     basePath: baseUrl,
     accessToken: () => Promise.resolve(apiKey),

src/tools/collection.ts

@@ -6,11 +6,7 @@ import type { ToolsFactory } from "./toolsFactory";
 import type { CollectionsApi } from "../gen/api/outline";
 import type { Logger } from "pino";
 
-export const registerCollectionTools: ToolsFactory<CollectionsApi> = (
+export const registerCollectionTools: ToolsFactory<CollectionsApi> = (server: McpServer, client: CollectionsApi, logger: Logger) => {
-  server: McpServer,
-  client: CollectionsApi,
-  logger: Logger
-) => {
   server.registerTool(
     "collections_list",
     {
@@ -21,15 +17,9 @@ export const registerCollectionTools: ToolsFactory<CollectionsApi> = (
     async () => {
       try {
         const response = await client.collectionsList();
-        return handleSuccess(
+        return handleSuccess(response, logger.child({ tool: "collections_list" }));
-          response,
-          logger.child({ tool: "collections_list" })
-        );
       } catch (err) {
-        const error = handleError(
+        const error = handleError(err, logger.child({ tool: "collections_list" }));
-          err,
-          logger.child({ tool: "collections_list" })
-        );
         logger.error(error);
         return error;
       }

src/tools/document.ts

@@ -1,45 +1,22 @@
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { z } from "zod";
-import type { Logger } from "pino";
 
-import {
+import { backlinkDocumentId, collectionId, direction, limit, offset, parentDocumentId, sort, userId } from "./common";
-  backlinkDocumentId,
-  collectionId,
-  direction,
-  limit,
-  offset,
-  parentDocumentId,
-  sort,
-  userId,
-} from "./common";
 import { handleSuccess, handleError } from "./utils";
+
 import type { ToolsFactory } from "./toolsFactory";
 import type { DocumentsApi } from "../gen/api/outline";
+import type { Logger } from "pino";
 
-export const registerDocumentTools: ToolsFactory<DocumentsApi> = (
+export const registerDocumentTools: ToolsFactory<DocumentsApi> = (server: McpServer, client: DocumentsApi, logger: Logger): void => {
-  server: McpServer,
-  client: DocumentsApi,
-  logger: Logger
-): void => {
   server.registerTool(
     "documents_info",
     {
       title: "Get Document Info",
-      description:
+      description: "Retrieve a document by its UUID, urlId, or shareId. At least one of these parameters must be provided.",
-        "Retrieve a document by its UUID, urlId, or shareId. At least one of these parameters must be provided.",
       inputSchema: {
-        id: z
+        id: z.string().optional().describe("Unique identifier for the document. Either the UUID or the urlId is acceptable."),
-          .string()
+        shareId: z.string().optional().describe("Unique identifier for a document share, a shareId may be used in place of a document UUID"),
-          .optional()
-          .describe(
-            "Unique identifier for the document. Either the UUID or the urlId is acceptable."
-          ),
-        shareId: z
-          .string()
-          .optional()
-          .describe(
-            "Unique identifier for a document share, a shareId may be used in place of a document UUID"
-          ),
       },
     },
     async (args) => {
@@ -50,10 +27,7 @@ export const registerDocumentTools: ToolsFactory<DocumentsApi> = (
             shareId: args?.shareId,
           },
         });
-        return handleSuccess(
+        return handleSuccess(response, logger.child({ tool: "documents_info" }));
-          response,
-          logger.child({ tool: "documents_info" })
-        );
       } catch (error) {
         return handleError(error, logger.child({ tool: "documents_info" }));
       }
@@ -76,8 +50,7 @@ export const registerDocumentTools: ToolsFactory<DocumentsApi> = (
     "documents_list",
     {
       title: "List Documents",
-      description:
+      description: "This method will list all published documents and draft documents belonging to the current user.",
-        "This method will list all published documents and draft documents belonging to the current user.",
       inputSchema: documentsListSchema.shape,
     },
     async (args) => {
@@ -86,10 +59,7 @@ export const registerDocumentTools: ToolsFactory<DocumentsApi> = (
         const response = await client.documentsList({
           documentsListRequest: validatedArgs,
         });
-        return handleSuccess(
+        return handleSuccess(response, logger.child({ tool: "documents_list" }));
-          response,
-          logger.child({ tool: "documents_list" })
-        );
       } catch (error) {
         return handleError(error, logger.child({ tool: "documents_list" }));
       }