OnSecurity MCP Server

Instructions

Implementation Reference

• src/index.ts:600-654 (handler)

  The handler function for the 'get-prerequisites' tool. It constructs filters with the required round_id, fetches data using fetchPage helper from the 'prerequisites' API endpoint, formats the results using formatPrerequisite and formatPaginationInfo, and returns a markdown-formatted text response.

  async (params) => {
      const filters: Record<string, string | number> = {
          'round_id-eq': params.round_id
      };
      
      // Add additional filters if provided
      if (params.filters) {
          Object.entries(params.filters).forEach(([key, value]) => {
              filters[key] = value;
          });
      }
      
      const response = await fetchPage<ApiResponse<PrerequisiteFeature>>(
          'prerequisites', 
          params.page || 1, 
          filters, 
          params.sort, 
          undefined, // includes not mentioned in the docs
          params.fields, 
          params.limit
      );
      
      if (!response) {
          return {
              content: [
                  {
                      type: "text",
                      text: "Error fetching prerequisites data. Please try again."
                  }
              ]
          };
      }
      
      const paginationInfo = formatPaginationInfo(response);
      const formattedPrerequisites = response.result.map(formatPrerequisite);
      
      const responseText = [
          "# Prerequisites Summary",
          "",
          "## Pagination Information",
          paginationInfo,
          "",
          "## Prerequisites Data",
          ...formattedPrerequisites
      ].join('\n');
  
      return {
          content: [
              {
                  type: "text",
                  text: responseText
              }
          ]
      };
  }

• src/index.ts:593-599 (schema)

  Zod schema defining the input parameters for the 'get-prerequisites' tool, including required round_id and optional pagination, sorting, and filtering options.

      round_id: z.number().describe("Required round ID to filter prerequisites"),
      sort: z.string().optional().describe("Optional sort parameter in format 'field-direction'. Available values: name-asc, name-desc, created_at-asc, created_at-desc, updated_at-asc, updated_at-desc. Default: id-asc"),
      limit: z.number().optional().describe("Optional limit parameter for max results per page (e.g. 15)"),
      page: z.number().optional().describe("Optional page number to fetch (default: 1)"),
      fields: z.string().optional().describe("Optional comma-separated list of fields to return (e.g. 'id,name,status'). Use * as wildcard."),
      filters: FilterSchema,
  },

• src/index.ts:589-655 (registration)

  The registration of the 'get-prerequisites' tool on the MCP server using server.tool(), including name, description, input schema, and handler function.

  server.tool(
      "get-prerequisites",
      "Get all prerequisites data from OnSecurity for a specific round. Prerequisites are requirements that need to be fulfilled before a security assessment can begin.",
      {
          round_id: z.number().describe("Required round ID to filter prerequisites"),
          sort: z.string().optional().describe("Optional sort parameter in format 'field-direction'. Available values: name-asc, name-desc, created_at-asc, created_at-desc, updated_at-asc, updated_at-desc. Default: id-asc"),
          limit: z.number().optional().describe("Optional limit parameter for max results per page (e.g. 15)"),
          page: z.number().optional().describe("Optional page number to fetch (default: 1)"),
          fields: z.string().optional().describe("Optional comma-separated list of fields to return (e.g. 'id,name,status'). Use * as wildcard."),
          filters: FilterSchema,
      },
      async (params) => {
          const filters: Record<string, string | number> = {
              'round_id-eq': params.round_id
          };
          
          // Add additional filters if provided
          if (params.filters) {
              Object.entries(params.filters).forEach(([key, value]) => {
                  filters[key] = value;
              });
          }
          
          const response = await fetchPage<ApiResponse<PrerequisiteFeature>>(
              'prerequisites', 
              params.page || 1, 
              filters, 
              params.sort, 
              undefined, // includes not mentioned in the docs
              params.fields, 
              params.limit
          );
          
          if (!response) {
              return {
                  content: [
                      {
                          type: "text",
                          text: "Error fetching prerequisites data. Please try again."
                      }
                  ]
              };
          }
          
          const paginationInfo = formatPaginationInfo(response);
          const formattedPrerequisites = response.result.map(formatPrerequisite);
          
          const responseText = [
              "# Prerequisites Summary",
              "",
              "## Pagination Information",
              paginationInfo,
              "",
              "## Prerequisites Data",
              ...formattedPrerequisites
          ].join('\n');
  
          return {
              content: [
                  {
                      type: "text",
                      text: responseText
                  }
              ]
          };
      }
  );

• src/index.ts:312-323 (helper)

  Helper function to format a single PrerequisiteFeature object into a human-readable string used in the tool's response.

  function formatPrerequisite(prerequisite: PrerequisiteFeature): string {
      return [
          `Prerequisite ID: ${prerequisite.id}`,
          `Round ID: ${prerequisite.round_id}`,
          `Name: ${prerequisite.name || "N/A"}`,
          `Description: ${prerequisite.description || "N/A"}`,
          `Required: ${prerequisite.required !== undefined ? prerequisite.required : "N/A"}`,
          `Status: ${prerequisite.status || "N/A"}`,
          `Created At: ${prerequisite.created_at || "N/A"}`,
          `Updated At: ${prerequisite.updated_at || "N/A"}`,
          `--------------------------------`,
      ].join('\n');

• src/index.ts:108-117 (schema)

  TypeScript interface defining the structure of a PrerequisiteFeature from the OnSecurity API, used in typing the API response.

  export interface PrerequisiteFeature {
      id: number;
      round_id: number;
      name?: string;
      description?: string;
      required?: boolean;
      status?: string;
      created_at?: string;
      updated_at?: string;
  }