CoinStats MCP Server

Instructions

Implementation Reference

• src/tools/toolConfigs.ts:268-282 (schema)

  Tool configuration defining the schema (Zod parameters), description, endpoint, and method for the 'get-exchange-transactions' tool.

  {
      name: 'get-exchange-transactions',
      description: 'Get transaction data for a specific exchange.',
      endpoint: '/exchange/transactions',
      method: 'GET',
      parameters: {
          portfolioId: z.string().describe('The identifier of portfolio, which you received from /exchange/balance response.'),
          page: z.number().optional().describe('Page number').default(1),
          limit: z.number().optional().describe('Number of results per page').default(20),
          from: z.string().optional().describe('Start date in ISO 8601 format'),
          to: z.string().optional().describe('End date in ISO 8601 format'),
          currency: z.string().optional().describe('Currency for price data').default('USD'),
          types: z.string().optional().describe('Transaction types, comma separated (deposit,withdraw,approve,executed,balance,fee)'),
      },
  },

• src/tools/toolFactory.ts:21-77 (handler)

  Generic handler function executed for the 'get-exchange-transactions' tool (and other API tools), which constructs the API request using the tool's configuration and calls universalApiHandler.

  server.tool(config.name, config.description, config.parameters, async (params: Record<string, any>) => {
      // Handle local operations
      if (config.isLocal) {
          // Handle specific local tools
          if (config.name === 'save-share-token') {
              await saveToCache('shareToken', params.shareToken);
              return {
                  content: [
                      {
                          type: 'text',
                          text: 'Share token saved successfully',
                      },
                  ],
              };
          }
  
          if (config.name === 'get-share-token') {
              const shareToken = await getFromCache('shareToken');
  
              return {
                  content: [
                      {
                          type: 'text',
                          text: shareToken ? shareToken : 'No share token found in cache',
                          isError: !shareToken,
                      },
                  ],
              };
          }
          // Future local tools can be added here
  
          // Default response for unhandled local tools
          return {
              content: [
                  {
                      type: 'text',
                      text: 'Operation completed',
                  },
              ],
          };
      }
  
      // Handle API operations
      const basePath = config.basePath || COINSTATS_API_BASE;
      const method = config.method || 'GET';
  
      // Methods that typically have a request body
      const bodyMethods = ['POST', 'PUT', 'PATCH', 'DELETE'];
  
      // For GET/DELETE requests, all params go in the URL
      // For POST/PUT/PATCH, send params as the body
      if (bodyMethods.includes(method.toUpperCase())) {
          return universalApiHandler(basePath, config.endpoint, method, {}, params);
      } else {
          return universalApiHandler(basePath, config.endpoint, method, params);
      }
  });

• src/tools/toolFactory.ts:19-79 (registration)

  Function that registers all tools, including 'get-exchange-transactions', with the MCP server by iterating over toolConfigs and calling server.tool.

  export function registerTools(server: McpServer, toolConfigs: ToolConfig<any>[]) {
      toolConfigs.forEach((config) => {
          server.tool(config.name, config.description, config.parameters, async (params: Record<string, any>) => {
              // Handle local operations
              if (config.isLocal) {
                  // Handle specific local tools
                  if (config.name === 'save-share-token') {
                      await saveToCache('shareToken', params.shareToken);
                      return {
                          content: [
                              {
                                  type: 'text',
                                  text: 'Share token saved successfully',
                              },
                          ],
                      };
                  }
  
                  if (config.name === 'get-share-token') {
                      const shareToken = await getFromCache('shareToken');
  
                      return {
                          content: [
                              {
                                  type: 'text',
                                  text: shareToken ? shareToken : 'No share token found in cache',
                                  isError: !shareToken,
                              },
                          ],
                      };
                  }
                  // Future local tools can be added here
  
                  // Default response for unhandled local tools
                  return {
                      content: [
                          {
                              type: 'text',
                              text: 'Operation completed',
                          },
                      ],
                  };
              }
  
              // Handle API operations
              const basePath = config.basePath || COINSTATS_API_BASE;
              const method = config.method || 'GET';
  
              // Methods that typically have a request body
              const bodyMethods = ['POST', 'PUT', 'PATCH', 'DELETE'];
  
              // For GET/DELETE requests, all params go in the URL
              // For POST/PUT/PATCH, send params as the body
              if (bodyMethods.includes(method.toUpperCase())) {
                  return universalApiHandler(basePath, config.endpoint, method, {}, params);
              } else {
                  return universalApiHandler(basePath, config.endpoint, method, params);
              }
          });
      });
  }

• src/index.ts:18-18 (registration)

  Calls registerTools to register all tools including 'get-exchange-transactions' on the MCP server instance.

  registerTools(server, allToolConfigs);

• src/services/request.ts:35-97 (helper)

  Core helper function that performs the actual HTTP request to the CoinStats API endpoint for tools like 'get-exchange-transactions', handling path params, query params, and response formatting.

  export async function universalApiHandler<T>(
      basePath: string,
      endpoint: string,
      method: string = 'GET',
      params: Record<string, any> = {},
      body?: any
  ): Promise<{
      content: Array<{ type: 'text'; text: string; isError?: boolean }>;
  }> {
      try {
          // Handle path parameters - replace {paramName} in endpoint with actual values
          let processedEndpoint = endpoint;
          let processedParams = { ...params };
  
          // Find all path parameters in the endpoint (e.g., {coinId}, {id}, {type})
          const pathParamMatches = endpoint.match(/\{([^}]+)\}/g);
  
          if (pathParamMatches) {
              for (const match of pathParamMatches) {
                  const paramName = match.slice(1, -1); // Remove { and }
  
                  if (processedParams[paramName] !== undefined) {
                      // Replace the placeholder with the actual value
                      processedEndpoint = processedEndpoint.replace(match, processedParams[paramName]);
                      // Remove the parameter from query params since it's now part of the path
                      delete processedParams[paramName];
                  } else {
                      throw new Error(`Required path parameter '${paramName}' is missing`);
                  }
              }
          }
  
          // MCP clients might not support '~' in parameter names, so we replace '-' with '~' specifically for the /coins endpoint before making the request.
          if (endpoint === '/coins') {
              processedParams = Object.entries(processedParams).reduce((acc, [key, value]) => {
                  acc[key.replace(/-/g, '~')] = value;
                  return acc;
              }, {} as Record<string, any>);
          }
  
          const url = `${basePath}${processedEndpoint}`;
          const data = await makeRequestCsApi<T>(url, method, processedParams, body);
  
          if (!data) {
              return {
                  content: [{ type: 'text', text: 'Something went wrong', isError: true }],
              };
          }
  
          return {
              content: [
                  {
                      type: 'text',
                      text: JSON.stringify(data),
                  },
              ],
          };
      } catch (error) {
          return {
              content: [{ type: 'text', text: `Error: ${error}`, isError: true }],
          };
      }
  }