Tools

1. greet: Greet the caller with a quintessential Hello World message.

   
   
   Input schema:

   {
     "properties": {
       "name": {
         "anyOf": [
           {
             "type": "string"
           },
           {
             "type": "null"
           }
         ],
         "default": null,
         "description": "The optional name to be greeted.",
         "title": "Name"
       }
     },
     "type": "object"
   }
   

   
   
   Output schema:

   {
     "properties": {
       "result": {
         "title": "Result",
         "type": "string"
       }
     },
     "required": [
       "result"
     ],
     "title": "_WrappedResult",
     "type": "object",
     "x-fastmcp-wrap-result": true
   }
   

   
   
   Annotations:

   {
     "title": null,
     "readOnlyHint": true,
     "destructiveHint": null,
     "idempotentHint": null,
     "openWorldHint": null
   }
   

   
   
   Metadata:

   {
     "_fastmcp": {
       "tags": [
         "example",
         "greeting"
       ]
     }
   }
   

2. generate_password: Generate a random password with specified length, optionally including special characters. The password will meet the complexity requirements of at least one lowercase letter, one uppercase letter, and two digits. If special characters are included, it will also contain at least one such character. Until the password meets these requirements, it will keep regenerating. This is a simple example of a tool that can be used to generate passwords. It is not intended for production use.

   
   
   Input schema:

   {
     "properties": {
       "length": {
         "default": 12,
         "description": "The length of the password to generate (between 8 and 64 characters).",
         "maximum": 64,
         "minimum": 8,
         "title": "Length",
         "type": "integer"
       },
       "use_special_chars": {
         "default": false,
         "description": "Include special characters in the password.",
         "title": "Use Special Chars",
         "type": "boolean"
       }
     },
     "type": "object"
   }
   

   
   
   Output schema:

   {
     "properties": {
       "result": {
         "title": "Result",
         "type": "string"
       }
     },
     "required": [
       "result"
     ],
     "title": "_WrappedResult",
     "type": "object",
     "x-fastmcp-wrap-result": true
   }
   

   
   
   Annotations:

   {
     "title": null,
     "readOnlyHint": true,
     "destructiveHint": null,
     "idempotentHint": null,
     "openWorldHint": null
   }
   

   
   
   Metadata:

   {
     "_fastmcp": {
       "tags": [
         "example",
         "password-generation"
       ]
     }
   }
   

3. text_web_search: Perform a text web search using the provided query using DDGS.

   
   
   Input schema:

   {
     "properties": {
       "query": {
         "description": "The search query to fetch results for. It should be a non-empty string.",
         "title": "Query",
         "type": "string"
       },
       "region": {
         "anyOf": [
           {
             "type": "string"
           },
           {
             "type": "null"
           }
         ],
         "default": "uk-en",
         "description": "Optional region to search in.",
         "title": "Region"
       },
       "max_results": {
         "anyOf": [
           {
             "maximum": 100,
             "minimum": 1,
             "type": "integer"
           },
           {
             "type": "null"
           }
         ],
         "default": 10,
         "description": "The maximum number of results to return. Default is 10, maximum is 100.",
         "title": "Max Results"
       },
       "pages": {
         "anyOf": [
           {
             "maximum": 10,
             "minimum": 1,
             "type": "integer"
           },
           {
             "type": "null"
           }
         ],
         "default": 1,
         "description": "The number of pages to fetch. Default is 1, maximum is 10.",
         "title": "Pages"
       }
     },
     "required": [
       "query"
     ],
     "type": "object"
   }
   

   
   
   Output schema:

   null
   

   
   
   Metadata:

   {
     "_fastmcp": {
       "tags": [
         "meta-search",
         "searchexample",
         "text-search"
       ]
     }
   }
   

4. permutations: Calculate the number of ways to choose k items from n items without repetition and with order. If k is not provided, it defaults to n.

   
   
   Input schema:

   {
     "properties": {
       "n": {
         "description": "The number of items to choose from.",
         "minimum": 1,
         "title": "N",
         "type": "integer"
       },
       "k": {
         "anyOf": [
           {
             "minimum": 1,
             "type": "integer"
           },
           {
             "type": "null"
           }
         ],
         "default": null,
         "description": "The optional number of items to choose.",
         "title": "K"
       }
     },
     "required": [
       "n"
     ],
     "type": "object"
   }
   

   
   
   Output schema:

   {
     "properties": {
       "result": {
         "title": "Result",
         "type": "integer"
       }
     },
     "required": [
       "result"
     ],
     "title": "_WrappedResult",
     "type": "object",
     "x-fastmcp-wrap-result": true
   }
   

   
   
   Annotations:

   {
     "title": null,
     "readOnlyHint": true,
     "destructiveHint": null,
     "idempotentHint": null,
     "openWorldHint": null
   }
   

   
   
   Metadata:

   {
     "_fastmcp": {
       "tags": [
         "example",
         "math",
         "permutation"
       ]
     }
   }
   

5. pirate_summary: Summarise the given text in a pirate style. This is an example of a tool that can use LLM sampling to generate a summary.

   
   
   Input schema:

   {
     "properties": {
       "text": {
         "title": "Text",
         "type": "string"
       }
     },
     "required": [
       "text"
     ],
     "type": "object"
   }
   

   
   
   Output schema:

   {
     "properties": {
       "result": {
         "title": "Result",
         "type": "string"
       }
     },
     "required": [
       "result"
     ],
     "title": "_WrappedResult",
     "type": "object",
     "x-fastmcp-wrap-result": true
   }
   

   
   
   Metadata:

   {
     "_fastmcp": {
       "tags": [
         "example",
         "llm-sampling",
         "pirate-summary"
       ]
     }
   }
   

6. vonmises_random: Generate a random number from the von Mises distribution. This is an example of a tool that uses elicitation to obtain the required parameter kappa (κ).

   
   
   Input schema:

   {
     "properties": {
       "mu": {
         "description": "The mean angle mu (\u03bc), expressed in radians between 0 and 2\u03c0",
         "maximum": 6.283185307179586,
         "minimum": 0,
         "title": "Mu",
         "type": "number"
       }
     },
     "required": [
       "mu"
     ],
     "type": "object"
   }
   

   
   
   Output schema:

   {
     "properties": {
       "result": {
         "title": "Result",
         "type": "number"
       }
     },
     "required": [
       "result"
     ],
     "title": "_WrappedResult",
     "type": "object",
     "x-fastmcp-wrap-result": true
   }
   

   
   
   Metadata:

   {
     "_fastmcp": {
       "tags": [
         "elicitation",
         "example",
         "experimental"
       ]
     }
   }