feat: add MCP resources for documentation

- Add examples and response format as MCP resources
- Create build script to handle version and resource files
- Add custom instructions for REST API testing
- Update server name to 'rest-api' in configuration examples
- Add version tracking through build-time generation

Author: dkmaker

.gitignore

@@ -1,4 +1,5 @@
 node_modules/
 build/
+src/version.ts
+.DS_Store
 *.log
-.env*

CLINE-CUSTOM-INSTRUCTIONS.md

@@ -0,0 +1,46 @@
+# REST API Testing Instructions
+
+Use this tool when testing, debugging, or interacting with REST API endpoints. The tool provides comprehensive request/response information and handles authentication automatically.
+
+## When to Use
+
+- Testing specific API endpoints
+- Debugging API responses
+- Verifying API functionality
+- Checking response times
+- Validating request/response formats
+- Testing local development servers
+- Testing API sequences
+- Verifying error handling
+
+## Key Features
+
+- Supports GET, POST, PUT, DELETE methods
+- Handles authentication (Basic, Bearer, API Key)
+- Normalizes endpoints automatically
+- Provides detailed response information
+- Configurable SSL verification
+
+## Getting Started
+
+1. Check available examples:
+```typescript
+<access_mcp_resource>
+<server_name>rest-api</server_name>
+<uri>rest-api://examples</uri>
+</access_mcp_resource>
+```
+
+2. Review response format:
+```typescript
+<access_mcp_resource>
+<server_name>rest-api</server_name>
+<uri>rest-api://response-format</uri>
+</access_mcp_resource>
+```
+
+## Important Notes
+
+- Review API implementation for expected behavior
+- Handle sensitive data appropriately
+- Consider rate limits and API constraints

README.md

@@ -36,7 +36,7 @@ Add to `C:\Users\<YourUsername>\AppData\Roaming\Code\User\globalStorage\saoudriz
 ```json
 {
   "mcpServers": {
-    "rest": {
+    "rest-api": {
       "command": "node",
       "args": [
         "C:/Users/<YourUsername>/AppData/Roaming/npm/node_modules/dkmaker-mcp-rest-api/build/index.js"
@@ -64,7 +64,7 @@ Add to `~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude
 ```json
 {
   "mcpServers": {
-    "rest": {
+    "rest-api": {
       "command": "npx",
       "args": [
         "-y",

package-lock.json

@@ -9,11 +9,14 @@
   },
   "files": [
     "build",
+    "scripts",
     "README.md",
     "LICENSE"
   ],
   "scripts": {
+    "prebuild": "node scripts/build.js",
     "build": "tsc",
+    "postbuild": "node scripts/build.js",
     "prepare": "npm run build",
     "watch": "tsc --watch",
     "inspector": "npx @modelcontextprotocol/inspector build/index.js"

package.json

@@ -0,0 +1,50 @@
+#!/usr/bin/env node
+import fs from 'fs/promises';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+async function main() {
+  const pkg = JSON.parse(
+    await fs.readFile(
+      path.join(__dirname, '..', 'package.json'),
+      'utf8'
+    )
+  );
+
+  const versionPath = path.join(__dirname, '..', 'src', 'version.ts');
+
+  // Always generate version.ts with actual values during build
+  const content = `// Auto-generated by build script
+export const VERSION = '${pkg.version}';
+export const PACKAGE_NAME = '${pkg.name}';
+export const SERVER_NAME = '${pkg.name.split('-').slice(-2).join('-')}';
+`;
+
+  await fs.writeFile(versionPath, content);
+  console.log('Generated version.ts with package values');
+
+  // Copy resources to build directory
+  const resourcesSrcDir = path.join(__dirname, '..', 'src', 'resources');
+  const resourcesBuildDir = path.join(__dirname, '..', 'build', 'resources');
+  
+  try {
+    await fs.mkdir(resourcesBuildDir, { recursive: true });
+    const files = await fs.readdir(resourcesSrcDir);
+    
+    for (const file of files) {
+      await fs.copyFile(
+        path.join(resourcesSrcDir, file),
+        path.join(resourcesBuildDir, file)
+      );
+    }
+    console.log('Copied resources to build directory');
+  } catch (error) {
+    console.error('Error copying resources:', error);
+    throw error;
+  }
+}
+
+main().catch(console.error);

scripts/build.js

@@ -5,9 +5,12 @@ import {
   CallToolRequestSchema,
   ErrorCode,
   ListToolsRequestSchema,
+  ListResourcesRequestSchema,
+  ReadResourceRequestSchema,
   McpError,
 } from '@modelcontextprotocol/sdk/types.js';
 import axios, { AxiosInstance, AxiosRequestConfig, Method } from 'axios';
+import { VERSION, PACKAGE_NAME, SERVER_NAME } from './version.js';
 
 if (!process.env.REST_BASE_URL) {
   throw new Error('REST_BASE_URL environment variable is required');
@@ -49,12 +52,13 @@ class RestTester {
   private async setupServer() {
     this.server = new Server(
       {
-        name: 'rest-tester',
-        version: '0.1.0',
+        name: SERVER_NAME,
+        version: VERSION,
       },
       {
         capabilities: {
           tools: {},
+          resources: {},
         },
       }
     );
@@ -69,6 +73,7 @@ class RestTester {
     });
 
     this.setupToolHandlers();
+    this.setupResourceHandlers();
 
     this.server.onerror = (error) => console.error('[MCP Error]', error);
     process.on('SIGINT', async () => {
@@ -77,6 +82,65 @@ class RestTester {
     });
   }
 
+  private setupResourceHandlers() {
+    this.server.setRequestHandler(ListResourcesRequestSchema, async () => ({
+      resources: [
+        {
+          uri: `${SERVER_NAME}://examples`,
+          name: 'REST API Usage Examples',
+          description: 'Detailed examples of using the REST API testing tool',
+          mimeType: 'text/markdown'
+        },
+        {
+          uri: `${SERVER_NAME}://response-format`,
+          name: 'Response Format Documentation',
+          description: 'Documentation of the response format and structure',
+          mimeType: 'text/markdown'
+        }
+      ]
+    }));
+
+    this.server.setRequestHandler(ReadResourceRequestSchema, async (request) => {
+      const uriPattern = new RegExp(`^${SERVER_NAME}://(.+)$`);
+      const match = request.params.uri.match(uriPattern);
+      
+      if (!match) {
+        throw new McpError(
+          ErrorCode.InvalidRequest,
+          `Invalid resource URI format: ${request.params.uri}`
+        );
+      }
+
+      const resource = match[1];
+      const fs = await import('fs');
+      const path = await import('path');
+
+      try {
+        const url = await import('url');
+        const __filename = url.fileURLToPath(import.meta.url);
+        const __dirname = path.dirname(__filename);
+        
+        // In the built app, resources are in build/resources
+        // In development, they're in src/resources
+        const resourcePath = path.join(__dirname, 'resources', `${resource}.md`);
+        const content = await fs.promises.readFile(resourcePath, 'utf8');
+
+        return {
+          contents: [{
+            uri: request.params.uri,
+            mimeType: 'text/markdown',
+            text: content
+          }]
+        };
+      } catch (error) {
+        throw new McpError(
+          ErrorCode.InvalidRequest,
+          `Resource not found: ${resource}`
+        );
+      }
+    });
+  }
+
   private setupToolHandlers() {
     this.server.setRequestHandler(ListToolsRequestSchema, async () => ({
       tools: [

src/index.ts

@@ -0,0 +1,60 @@
+# REST API Testing Examples
+
+## Basic GET Request
+```typescript
+{
+  "method": "GET",
+  "endpoint": "/users"
+}
+```
+
+## GET with Query Parameters
+```typescript
+{
+  "method": "GET",
+  "endpoint": "/users?role=admin&status=active"
+}
+```
+
+## POST Request with Body
+```typescript
+{
+  "method": "POST",
+  "endpoint": "/users",
+  "body": {
+    "name": "John Doe",
+    "email": "john@example.com"
+  }
+}
+```
+
+## Request with Custom Headers
+```typescript
+{
+  "method": "GET",
+  "endpoint": "/secure-resource",
+  "headers": {
+    "Custom-Header": "value",
+    "Another-Header": "another-value"
+  }
+}
+```
+
+## PUT Request Example
+```typescript
+{
+  "method": "PUT",
+  "endpoint": "/users/123",
+  "body": {
+    "name": "Updated Name",
+    "status": "inactive"
+  }
+}
+```
+
+## DELETE Request Example
+```typescript
+{
+  "method": "DELETE",
+  "endpoint": "/users/123"
+}

src/resources/examples.md

@@ -0,0 +1,64 @@
+# Response Format Documentation
+
+The REST API testing tool returns a comprehensive JSON response containing request details, response information, and validation results.
+
+## Response Structure
+
+```json
+{
+  "request": {
+    "url": "http://api.example.com/users",
+    "method": "GET",
+    "headers": {},
+    "body": null,
+    "authMethod": "none"
+  },
+  "response": {
+    "statusCode": 200,
+    "statusText": "OK",
+    "timing": "123ms",
+    "headers": {},
+    "body": {}
+  },
+  "validation": {
+    "isError": false,
+    "messages": ["Request completed successfully"]
+  }
+}
+```
+
+## Response Fields
+
+### Request Details
+- `url`: Full URL including base URL and endpoint
+- `method`: HTTP method used
+- `headers`: Request headers sent
+- `body`: Request body (if applicable)
+- `authMethod`: Authentication method used (none, basic, bearer, or apikey)
+
+### Response Details
+- `statusCode`: HTTP status code
+- `statusText`: Status message
+- `timing`: Request duration in milliseconds
+- `headers`: Response headers received
+- `body`: Response body content
+
+### Validation
+- `isError`: true if status code >= 400
+- `messages`: Array of validation or error messages
+
+## Error Response Example
+
+```json
+{
+  "error": {
+    "message": "Connection refused",
+    "code": "ECONNREFUSED",
+    "request": {
+      "url": "http://api.example.com/users",
+      "method": "GET",
+      "headers": {},
+      "body": null
+    }
+  }
+}

src/resources/response-format.md

@@ -0,0 +1,6 @@
+// Template file for TypeScript during development
+// The actual version.ts will be generated during build
+
+export const VERSION = '0.0.0';
+export const PACKAGE_NAME = 'dkmaker-mcp-rest-api';
+export const SERVER_NAME = 'rest-api';