fast-mcp 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 247f36763da6fd88d9c9e454d5d63eaeb351d08a72de8c2e5dc65919d9e2a9f1
-  data.tar.gz: 846d3427bb33357cfdc6c5387d153d393449792455beab413e36eeb8d0f1bf1d
+  metadata.gz: 50141727429ea7f39887b8a0f6ec2da8515cc3c35803a1c3e328287931bebcae
+  data.tar.gz: 518a481ba94b59f339b4e4957c54971866a76835e54833fd408efdb12e97c0e8
 SHA512:
-  metadata.gz: 8917675ff31b47cd67ddc5171a0c1e853cca9ba8a5853a7a9314ab5b794c9868c7c48b2db17dbd2edb580e81e9b12de8a0318151239babc2a5971cc2d4b10d72
-  data.tar.gz: 926a58cda786415804f88bb7d2cbabe91fe90b6ae84964be9452070f0ac4de7a29705eedd69af79c641c4e4086865b5dda3438108f1cb068457b1b9c2930472e
+  metadata.gz: 76f1f6136bc4f1041021f5a3522f230ae1f044bb19e2e0d8f0871249aac222740b3907229db4b7d482812396f03d492cd6ea414206008f3737361e4346cbb5ca
+  data.tar.gz: 1ac14395b264d76b826feb2612a0ceae18933c8b37695ba8e5c673c6c5b29045f241617a2196409267f1c4c58b1fef0b3ff9865d92fae759306a6b17e2795db2

data/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.4.0] - 2025-05-10
+### Added
+- Conditionnally hidden properties for tool calls (#70) [#70 @yjacquin](https://github.com/yjacquin/fast-mcp/pull/70)
+- Metadata to tool call results (#69) [#69 @yjacquin](https://github.com/yjacquin/fast-mcp/pull/69)
+- Link to official Discord Server in README.md
+
 ## [1.3.2] - 2025-05-08
 ### Changed
 - Logs are now less verbose by default [#64 @yjacquin](https://github.com/yjacquin/fast-mcp/pull/64)

data/README.md

@@ -10,6 +10,7 @@
   <a href="https://github.com/yjacquin/fast-mcp/workflows/CI/badge.svg"><img src="https://github.com/yjacquin/fast-mcp/workflows/CI/badge.svg" alt="CI Status" /></a>
   <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT" /></a>
   <a href="code_of_conduct.md"><img src="https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg" alt="Contributor Covenant" /></a>
+  <a href="https://discord.gg/ayu8ZKvz"><img src = "https://dcbadge.limes.pink/api/server/https://discord.gg/ayu8ZKvz?style=flat" alt="Discord invite link" /></a>
 </p>
 
 ## 🌟 Interface your Servers with LLMs in minutes !

data/lib/mcp/server.rb

@@ -304,10 +304,10 @@ module FastMcp
       begin
         # Convert string keys to symbols for Ruby
         symbolized_args = symbolize_keys(arguments)
-        result = tool.new.call_with_schema_validation!(**symbolized_args)
+        result, metadata = tool.new.call_with_schema_validation!(**symbolized_args)
 
         # Format and send the result
-        send_formatted_result(result, id)
+        send_formatted_result(result, id, metadata)
       rescue FastMcp::Tool::InvalidArgumentsError => e
         @logger.error("Invalid arguments for tool #{tool_name}: #{e.message}")
         send_error_result(e.message, id)
@@ -318,18 +318,18 @@ module FastMcp
     end
 
     # Format and send successful result
-    def send_formatted_result(result, id)
+    def send_formatted_result(result, id, metadata)
       # Check if the result is already in the expected format
       if result.is_a?(Hash) && result.key?(:content)
-        # Result is already in the correct format
-        send_result(result, id)
+        send_result(result, id, metadata: metadata)
       else
         # Format the result according to the MCP specification
         formatted_result = {
           content: [{ type: 'text', text: result.to_s }],
           isError: false
         }
-        send_result(formatted_result, id)
+
+        send_result(formatted_result, id, metadata: metadata)
       end
     end
 
@@ -340,6 +340,7 @@ module FastMcp
         content: [{ type: 'text', text: "Error: #{message}" }],
         isError: true
       }
+
       send_result(error_result, id)
     end
 
@@ -408,7 +409,9 @@ module FastMcp
     end
 
     # Send a JSON-RPC result response
-    def send_result(result, id)
+    def send_result(result, id, metadata: {})
+      result[:_meta] = metadata if metadata.is_a?(Hash) && !metadata.empty?
+
       response = {
         jsonrpc: '2.0',
         id: id,
@@ -429,6 +432,7 @@ module FastMcp
         },
         id: id
       }
+
       send_response(response)
     end
 

data/lib/mcp/tool.rb

@@ -11,6 +11,14 @@ module Dry
         def description(text)
           key_name = name.to_sym
           schema_dsl.meta(key_name, :description, text)
+
+          self
+        end
+
+        def hidden(hidden = true) # rubocop:disable Style/OptionalBooleanParameter
+          key_name = name.to_sym
+          schema_dsl.meta(key_name, :hidden, hidden)
+
           self
         end
       end
@@ -20,6 +28,14 @@ module Dry
         def description(text)
           key_name = name.to_sym
           schema_dsl.meta(key_name, :description, text)
+
+          self
+        end
+
+        def hidden(hidden = true) # rubocop:disable Style/OptionalBooleanParameter
+          key_name = name.to_sym
+          schema_dsl.meta(key_name, :hidden, hidden)
+
           self
         end
       end
@@ -29,6 +45,14 @@ module Dry
         def description(text)
           key_name = name.to_sym
           schema_dsl.meta(key_name, :description, text)
+
+          self
+        end
+
+        def hidden(hidden = true) # rubocop:disable Style/OptionalBooleanParameter
+          key_name = name.to_sym
+          schema_dsl.meta(key_name, :hidden, hidden)
+
           self
         end
       end
@@ -102,6 +126,12 @@ module FastMcp
       end
     end
 
+    def initialize
+      @_meta = {}
+    end
+
+    attr_accessor :_meta
+
     def notify_resource_updated(uri)
       self.class.server.notify_resource_updated(uri)
     end
@@ -110,106 +140,93 @@ module FastMcp
       arg_validation = self.class.input_schema.call(args)
       raise InvalidArgumentsError, arg_validation.errors.to_h.to_json if arg_validation.errors.any?
 
-      call(**args)
+      # When calling the tool, its metadata can be altered to be returned in response.
+      # We return the altered metadata with the tool's result
+      [call(**args), _meta]
     end
   end
 
-  # Module for handling schema descriptions
-  module SchemaDescriptionExtractor
-    # Extract descriptions from a schema
-    def extract_descriptions_from_schema(schema)
-      descriptions = {}
+  # Module for handling schema metadata
+  module SchemaMetadataExtractor
+    # Extract metadata from a schema
+    def extract_metadata_from_schema(schema)
+      # a deeply-assignable hash, the default value of a key is {}
+      metadata = Hash.new { |h, k| h[k] = Hash.new(&h.default_proc) }
 
       # Extract descriptions from the top-level schema
       if schema.respond_to?(:schema_dsl) && schema.schema_dsl.respond_to?(:meta_data)
         schema.schema_dsl.meta_data.each do |key, meta|
-          descriptions[key.to_s] = meta[:description] if meta[:description]
+          metadata[key.to_s][:description] = meta[:description] if meta[:description]
+          metadata[key.to_s][:hidden] = meta[:hidden]
         end
       end
 
-      # Extract descriptions from nested schemas using AST
+      # Extract metadata from nested schemas using AST
       schema.rules.each_value do |rule|
         next unless rule.respond_to?(:ast)
 
-        extract_descriptions_from_ast(rule.ast, descriptions)
+        extract_metadata_from_ast(rule.ast, metadata)
       end
 
-      # Special case for the nested properties test
-      handle_special_case_for_person(schema, descriptions)
-
-      descriptions
-    end
-
-    # Handle special case for person schema in tests
-    def handle_special_case_for_person(schema, descriptions)
-      return unless schema.rules.key?(:person) &&
-                    schema.rules[:person].respond_to?(:rule) &&
-                    schema.rules[:person].rule.is_a?(Dry::Logic::Operations::And)
-
-      # Check if this is the test schema with person.first_name and person.last_name
-      person_rule = schema.rules[:person]
-      return unless person_rule.rule.rules.any? { |r| r.is_a?(Dry::Logic::Operations::Set) }
-
-      descriptions['person.first_name'] = 'First name of the person'
-      descriptions['person.last_name'] = 'Last name of the person'
+      metadata
     end
 
-    # Extract descriptions from AST
-    def extract_descriptions_from_ast(ast, descriptions, parent_key = nil)
+    # Extract metadata from AST
+    def extract_metadata_from_ast(ast, metadata, parent_key = nil)
       return unless ast.is_a?(Array)
 
-      process_key_node(ast, descriptions, parent_key) if ast[0] == :key
-      process_set_node(ast, descriptions, parent_key) if ast[0] == :set
-      process_and_node(ast, descriptions, parent_key) if ast[0] == :and
+      process_key_node(ast, metadata, parent_key) if ast[0] == :key
+      process_set_node(ast, metadata, parent_key) if ast[0] == :set
+      process_and_node(ast, metadata, parent_key) if ast[0] == :and
     end
 
     # Process a key node in the AST
-    def process_key_node(ast, descriptions, parent_key)
+    def process_key_node(ast, metadata, parent_key)
       return unless ast[1].is_a?(Array) && ast[1].size >= 2
 
       key = ast[1][0]
       full_key = parent_key ? "#{parent_key}.#{key}" : key.to_s
 
       # Process nested AST
-      extract_descriptions_from_ast(ast[1][1], descriptions, full_key) if ast[1][1].is_a?(Array)
+      extract_metadata_from_ast(ast[1][1], metadata, full_key) if ast[1][1].is_a?(Array)
     end
 
     # Process a set node in the AST
-    def process_set_node(ast, descriptions, parent_key)
+    def process_set_node(ast, metadata, parent_key)
       return unless ast[1].is_a?(Array)
 
       ast[1].each do |set_node|
-        extract_descriptions_from_ast(set_node, descriptions, parent_key)
+        extract_metadata_from_ast(set_node, metadata, parent_key)
       end
     end
 
     # Process an and node in the AST
-    def process_and_node(ast, descriptions, parent_key)
+    def process_and_node(ast, metadata, parent_key)
       return unless ast[1].is_a?(Array)
 
       # Process each child node
       ast[1].each do |and_node|
-        extract_descriptions_from_ast(and_node, descriptions, parent_key)
+        extract_metadata_from_ast(and_node, metadata, parent_key)
       end
 
       # Process nested properties
-      process_nested_properties(ast, descriptions, parent_key)
+      process_nested_properties(ast, metadata, parent_key)
     end
 
     # Process nested properties in an and node
-    def process_nested_properties(ast, descriptions, parent_key)
+    def process_nested_properties(ast, metadata, parent_key)
       ast[1].each do |node|
         next unless node[0] == :key && node[1].is_a?(Array) && node[1][1].is_a?(Array) && node[1][1][0] == :and
 
         key_name = node[1][0]
         nested_key = parent_key ? "#{parent_key}.#{key_name}" : key_name.to_s
 
-        process_nested_schema_ast(node[1][1], descriptions, nested_key)
+        process_nested_schema_ast(node[1][1], metadata, nested_key)
       end
     end
 
     # Process a nested schema
-    def process_nested_schema_ast(ast, descriptions, nested_key)
+    def process_nested_schema_ast(ast, metadata, nested_key)
       return unless ast[1].is_a?(Array)
 
       ast[1].each do |subnode|
@@ -218,31 +235,31 @@ module FastMcp
         subnode[1].each do |set_node|
           next unless set_node[0] == :and && set_node[1].is_a?(Array)
 
-          process_nested_keys(set_node, descriptions, nested_key)
+          process_nested_keys(set_node, metadata, nested_key)
         end
       end
     end
 
     # Process nested keys in a schema
-    def process_nested_keys(set_node, descriptions, nested_key)
+    def process_nested_keys(set_node, metadata, nested_key)
       set_node[1].each do |and_node|
         next unless and_node[0] == :key && and_node[1].is_a?(Array) && and_node[1].size >= 2
 
         nested_field = and_node[1][0]
         nested_path = "#{nested_key}.#{nested_field}"
 
-        extract_meta_description(and_node, descriptions, nested_path)
+        extract_metadata(and_node, metadata, nested_path)
       end
     end
 
-    # Extract meta description from a node
-    def extract_meta_description(and_node, descriptions, nested_path)
+    # Extract metadata from a node
+    def extract_metadata(and_node, metadata, nested_path)
       return unless and_node[1][1].is_a?(Array) && and_node[1][1][1].is_a?(Array)
 
       and_node[1][1][1].each do |meta_node|
         next unless meta_node[0] == :meta && meta_node[1].is_a?(Hash) && meta_node[1][:description]
 
-        descriptions[nested_path] = meta_node[1][:description]
+        metadata[nested_path] = meta_node[1][:description]
       end
     end
   end
@@ -251,9 +268,7 @@ module FastMcp
   module RuleTypeDetector
     # Check if a rule is for a hash type
     def hash_type?(rule)
-      return true if direct_hash_predicate?(rule)
-      return true if nested_hash_predicate?(rule)
-      return true if special_case_hash?(rule)
+      return true if direct_hash_predicate?(rule) || nested_hash_predicate?(rule)
 
       false
     end
@@ -279,28 +294,6 @@ module FastMcp
       false
     end
 
-    # Check for special case hash
-    def special_case_hash?(rule)
-      # Special case for schema_compiler_spec.rb tests
-      return true if rule.respond_to?(:path) && [:metadata, :user].include?(rule.path)
-
-      # Special case for person hash in the test
-      return false unless rule.respond_to?(:ast)
-
-      ast = rule.ast
-      return false unless ast[0] == :and && ast[1].is_a?(Array)
-
-      ast[1].each do |node|
-        next unless node[0] == :key && node[1].is_a?(Array) && node[1][1].is_a?(Array) && node[1][1][0] == :and
-
-        node[1][1][1].each do |subnode|
-          return true if subnode[0] == :predicate && subnode[1].is_a?(Array) && subnode[1][0] == :hash?
-        end
-      end
-
-      false
-    end
-
     # Check if a rule is for an array type
     def array_type?(rule)
       rule.is_a?(Dry::Logic::Operations::And) &&
@@ -625,7 +618,7 @@ module FastMcp
 
   # SchemaCompiler class for converting Dry::Schema to JSON Schema
   class SchemaCompiler
-    include SchemaDescriptionExtractor
+    include SchemaMetadataExtractor
     include RuleTypeDetector
     include PredicateHandler
     include BasicTypePredicateHandler
@@ -653,8 +646,8 @@ module FastMcp
       # Store the schema for later use
       @schema = schema
 
-      # Extract descriptions from the schema
-      @descriptions = extract_descriptions_from_schema(schema)
+      # Extract metadata from the schema
+      @metadata = extract_metadata_from_schema(schema)
 
       # Process each rule in the schema
       schema.rules.each do |key, rule|
@@ -668,6 +661,9 @@ module FastMcp
     end
 
     def process_rule(key, rule)
+      # Skip if this property is hidden
+      return if @metadata.dig(key.to_s, :hidden) == true
+
       # Initialize property if it doesn't exist
       @json_schema[:properties][key] ||= {}
 
@@ -678,7 +674,8 @@ module FastMcp
       extract_predicates(rule, key)
 
       # Add description if available
-      @json_schema[:properties][key][:description] = @descriptions[key.to_s] if @descriptions.key?(key.to_s)
+      description = @metadata.dig(key.to_s, :description)
+      @json_schema[:properties][key][:description] = description unless description && description.empty?
 
       # Check if this is a hash type
       is_hash = hash_type?(rule)
@@ -725,8 +722,9 @@ module FastMcp
 
       # Add description if available for nested property
       nested_key_path = "#{key}.#{nested_key}"
-      if @descriptions.key?(nested_key_path)
-        @json_schema[:properties][key][:properties][nested_key][:description] = @descriptions[nested_key_path]
+      description = @metadata.dig(nested_key_path, :description)
+      unless description && description.empty?
+        @json_schema[:properties][key][:properties][nested_key][:description] = description
       end
 
       # Special case for the test with person.first_name and person.last_name

data/lib/mcp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FastMcp
-  VERSION = '1.3.2'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast-mcp
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Yorick Jacquin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-09 00:00:00.000000000 Z
+date: 2025-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64