Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| DEBUG | No | Enable debug logging | false |
| API_KEY | Yes | Your API key for authentication | |
| API_TIMEOUT | No | Request timeout in seconds | 30 |
| API_BASE_URL | No | Base URL for the backend API | https://api.example.com/v1 |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| health_check | Check the health status of the MCP server. Returns: A dictionary with the server status and configuration info. |
| list_items | List all items with optional filtering and pagination. Args: page: Page number (1-indexed) page_size: Number of items per page filter_name: Optional filter by name (case-insensitive contains) Returns: A dictionary containing: - items: List of item objects - total: Total number of items matching the filter - page: Current page number - page_size: Number of items per page |
| get_item | Get a specific item by ID. Args: item_id: The unique identifier of the item Returns: The item data if found Raises: ValueError: If the item is not found |
| create_item | Create a new item. Args: name: The name of the item (required) description: Optional description metadata: Optional key-value metadata Returns: The created item data including the generated ID |
| update_item | Update an existing item. Args: item_id: The unique identifier of the item to update name: New name (optional) description: New description (optional) metadata: New metadata (optional, replaces existing) Returns: The updated item data Raises: ValueError: If the item is not found |
| delete_item | Delete an item. Args: item_id: The unique identifier of the item to delete Returns: A confirmation message Raises: ValueError: If the item is not found |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
| getting_started | A prompt to help users get started with this MCP server. |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
| get_status | Get the current server status. |