feat: add config documentation and improve URL resolution examples

- Add config.md resource documenting all configuration options
- Update tool description to show actual URL resolution
- Simplify instructions to reference config resource
- Remove environment variable references from user-facing messages

Author: dkmaker

CLINE-CUSTOM-INSTRUCTIONS.md

@@ -19,28 +19,21 @@ The `test_request` tool enables testing, debugging, and interacting with REST AP
 - 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>
-```
+- Configurable SSL verification and response limits
+
+## Resources
+
+The following resources provide detailed documentation:
+
+- examples: Usage examples and common patterns
+- response-format: Response structure and fields
+- config: Configuration options and setup guide
+
+Access these resources to understand usage, response formats, and configuration options.
 
 ## Important Notes
 
 - Review API implementation for expected behavior
 - Handle sensitive data appropriately
 - Consider rate limits and API constraints
+- Restart server after configuration changes

src/index.ts

@@ -72,6 +72,18 @@ const isValidEndpointArgs = (args: any): args is EndpointArgs => {
   if (!['GET', 'POST', 'PUT', 'DELETE'].includes(args.method)) return false;
   if (typeof args.endpoint !== 'string') return false;
   if (args.headers !== undefined && typeof args.headers !== 'object') return false;
+  
+  // Check if endpoint contains a full URL
+  const urlPattern = /^(https?:\/\/|www\.)/i;
+  if (urlPattern.test(args.endpoint)) {
+    throw new McpError(
+      ErrorCode.InvalidParams,
+      `Invalid endpoint format. Do not include full URLs. Instead of "${args.endpoint}", use just the path (e.g. "/api/users"). ` +
+      `Your path will be resolved to: ${process.env.REST_BASE_URL}${args.endpoint.replace(/^\/+|\/+$/g, '')}. ` +
+      `To test a different base URL, update the REST_BASE_URL environment variable.`
+    );
+  }
+  
   return true;
 };
 
@@ -134,6 +146,12 @@ class RestTester {
           name: 'Response Format Documentation',
           description: 'Documentation of the response format and structure',
           mimeType: 'text/markdown'
+        },
+        {
+          uri: `${SERVER_NAME}://config`,
+          name: 'Configuration Documentation',
+          description: 'Documentation of all configuration options and how to use them',
+          mimeType: 'text/markdown'
         }
       ]
     }));
@@ -188,7 +206,7 @@ class RestTester {
 
 Base URL: ${process.env.REST_BASE_URL}
 
-SSL Verification: ${REST_ENABLE_SSL_VERIFY ? 'Enabled (default)' : 'Disabled (set REST_ENABLE_SSL_VERIFY=false to disable for self-signed certificates)'}
+SSL Verification: ${REST_ENABLE_SSL_VERIFY ? 'Enabled' : 'Disabled'} (see config resource for SSL settings)
 
 Authentication: ${
   hasBasicAuth() ? 
@@ -204,7 +222,7 @@ The tool automatically:
 - Normalizes endpoints (adds leading slash, removes trailing slashes)
 - Handles authentication header injection
 - Accepts any HTTP status code as valid
-- Limits response size to ${RESPONSE_SIZE_LIMIT} bytes (configurable via REST_RESPONSE_SIZE_LIMIT)
+- Limits response size to ${RESPONSE_SIZE_LIMIT} bytes (see config resource for size limit settings)
 - Returns detailed response information including:
   * Full URL called
   * Status code and text
@@ -218,6 +236,8 @@ Error Handling:
 - Network errors are caught and returned with descriptive messages
 - Invalid status codes are still returned with full response details
 - Authentication errors include the attempted auth method
+
+See the config resource for all configuration options.
 `,
           inputSchema: {
             type: 'object',
@@ -229,7 +249,7 @@ Error Handling:
               },
               endpoint: {
                 type: 'string',
-                description: 'Endpoint path (e.g. "/users"). Will be appended to base URL.',
+                description: `Endpoint path (e.g. "/users"). Do not include full URLs - only the path. Example: "/api/users" will resolve to "${process.env.REST_BASE_URL}/api/users"`,
               },
               body: {
                 type: 'object',

src/resources/config.md

@@ -0,0 +1,83 @@
+# REST API Tester Configuration
+
+This document describes all available configuration options for the REST API testing tool.
+
+## Core Configuration
+
+### REST_BASE_URL (Required)
+- Description: The base URL that all endpoint paths will be resolved against
+- Example: `http://localhost:3000` or `https://api.example.com`
+- Usage: All endpoint paths will be appended to this URL. For example, if REST_BASE_URL is `http://localhost:3000` and you use the endpoint `/api/users`, the full URL will be `http://localhost:3000/api/users`
+
+### REST_RESPONSE_SIZE_LIMIT (Optional)
+- Description: Maximum size in bytes for response data
+- Default: 10000 (10KB)
+- Example: `50000` for 50KB limit
+- Usage: Helps prevent memory issues with large responses. If a response exceeds this size, it will be truncated and a warning message will be included
+
+### REST_ENABLE_SSL_VERIFY (Optional)
+- Description: Controls SSL certificate verification
+- Default: `true`
+- Values: Set to `false` to disable SSL verification for self-signed certificates
+- Usage: Disable when testing APIs with self-signed certificates in development environments
+
+## Authentication Configuration
+
+The tool supports three authentication methods. Configure one based on your API's requirements.
+
+### Basic Authentication
+- REST_BASIC_USERNAME: Username for Basic Auth
+- REST_BASIC_PASSWORD: Password for Basic Auth
+- Usage: When both are set, requests will include Basic Auth header
+
+### Bearer Token
+- REST_BEARER: Bearer token value
+- Usage: When set, requests will include `Authorization: Bearer <token>` header
+
+### API Key
+- REST_APIKEY_HEADER_NAME: Name of the header for API key
+- REST_APIKEY_VALUE: Value of the API key
+- Example:
+  ```
+  REST_APIKEY_HEADER_NAME=X-API-Key
+  REST_APIKEY_VALUE=your-api-key-here
+  ```
+- Usage: When both are set, requests will include the specified header with the API key
+
+## Configuration Examples
+
+### Local Development
+```bash
+REST_BASE_URL=http://localhost:3000
+REST_ENABLE_SSL_VERIFY=false
+REST_RESPONSE_SIZE_LIMIT=50000
+```
+
+### Production API with Bearer Token
+```bash
+REST_BASE_URL=https://api.example.com
+REST_BEARER=your-bearer-token
+```
+
+### API with Basic Auth
+```bash
+REST_BASE_URL=https://api.example.com
+REST_BASIC_USERNAME=admin
+REST_BASIC_PASSWORD=secret
+```
+
+### API with API Key
+```bash
+REST_BASE_URL=https://api.example.com
+REST_APIKEY_HEADER_NAME=X-API-Key
+REST_APIKEY_VALUE=your-api-key
+```
+
+## Changing Configuration
+
+Configuration can be updated by:
+1. Setting environment variables before starting the server
+2. Modifying the MCP server configuration file
+3. Using environment variable commands in your terminal
+
+Remember to restart the server after changing configuration for the changes to take effect.

src/resources/examples.md

@@ -1,10 +1,16 @@
 # REST API Testing Examples
 
+⚠️ IMPORTANT: Only provide the endpoint path - do not include full URLs. Your path will be automatically resolved to the full URL.
+
+For example, if the base URL is `http://localhost:3000`:
+✅ Correct: `"/api/users"` → Resolves to: `http://localhost:3000/api/users`
+❌ Incorrect: `"http://localhost:3000/api/users"` or `"www.example.com/api/users"`
+
 ## Basic GET Request
 ```typescript
 use_mcp_tool('rest-api', 'test_request', {
   "method": "GET",
-  "endpoint": "/users"
+  "endpoint": "/users"  // Will be appended to REST_BASE_URL
 });
 ```
 
@@ -58,3 +64,17 @@ use_mcp_tool('rest-api', 'test_request', {
   "method": "DELETE",
   "endpoint": "/users/123"
 });
+```
+
+## Changing Base URL
+If you need to test against a different base URL, update the base URL configuration rather than including the full URL in the endpoint parameter.
+
+Example:
+```bash
+# Instead of this:
+❌ "endpoint": "https://api.example.com/users"  # Wrong - don't include the full URL
+
+# Do this:
+# 1. Update the base URL configuration to: https://api.example.com
+# 2. Then use just the path:
+✅ "endpoint": "/users"  # This will resolve to: https://api.example.com/users