schwab_mcp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c9da3afacad3bb1272bbff0e797dcaf882352d1263ab620446dd0c97d329debc
+  data.tar.gz: 6ea0e964b8ab66f7d92fc88b766b5c4d3569d18ed2b016ae35053e0d0a11b159
+SHA512:
+  metadata.gz: 5000ea77ea70965802bf6b8bac785f01edb98b66568f3197678b5294aaa98a2f7e8e79912ca820307b06f40990ddfe6a24c2f51b24afbab947ee07c6ab909560
+  data.tar.gz: 5515f8088908d5a8a5a5f6e104ab4e29d6024acf275791b854eb00cbf7029868a5ce59d3b55e6b7aec66835baf1d3112a4ccf5aafb13bfdcc08482887690c74c

data/.copilotignore

@@ -0,0 +1,3 @@
+.env
+token.json
+Gemlfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-07-10
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Joseph Platta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,157 @@
+# SchwabMCP
+
+A Model Context Protocol (MCP) server that provides AI assistants like Claude with secure access to Schwab's trading API. This gem enables natural language interactions with your Schwab brokerage account for retrieving market data, quotes, option chains, account information, and managing trades.
+
+This gem is built on top of the [schwab_rb](https://github.com/jwplatta/schwab_rb) Ruby gem, which provides the underlying Schwab API client functionality.
+
+## Installation
+
+Add this gem to your application's Gemfile:
+
+```bash
+bundle add schwab_mcp
+```
+
+Or install it directly:
+
+```bash
+gem install schwab_mcp
+```
+
+### Prerequisites
+
+Before using this gem, you'll need:
+
+1. A Schwab Developer account and API credentials
+2. Environment variables configured (see Usage section)
+3. Valid Schwab API tokens
+
+**Dependencies:**
+- This gem depends on [schwab_rb](https://github.com/jwplatta/schwab_rb) for Schwab API communication
+- Ruby 3.1.0 or higher
+
+## Usage
+
+### Environment Setup
+
+Create a `.env` file in your project root with the following required variables:
+
+```bash
+SCHWAB_API_KEY=your_schwab_api_key
+SCHWAB_APP_SECRET=your_schwab_app_secret
+SCHWAB_CALLBACK_URI=your_callback_uri
+TOKEN_PATH=path/to/your/token.json
+```
+
+### Running the MCP Server
+
+Start the server using the provided executable:
+
+```bash
+bundle exec exe/schwab_mcp
+```
+
+Or use the convenience script:
+
+```bash
+./start_mcp_server.sh
+```
+
+### Token Management
+
+The gem includes utility scripts for managing Schwab API authentication tokens:
+
+#### Refresh Tokens
+
+To refresh your existing authentication tokens:
+
+```bash
+bundle exec exe/schwab_token_refresh
+```
+
+This script will automatically refresh your tokens using the existing token file specified in your `TOKEN_PATH` environment variable.
+
+#### Reset Tokens
+
+To delete existing tokens and start the authentication process fresh:
+
+```bash
+bundle exec exe/schwab_token_reset
+```
+
+This script will:
+1. Delete your existing token file
+2. Guide you through the OAuth authentication flow to obtain new tokens
+
+### Available Tools
+
+The MCP server provides the following tools for AI assistants:
+
+- **Market Data**: Get quotes, option chains, price history, and market hours
+- **Account Management**: View account details, balances, and positions
+- **Order Management**: Preview, place, cancel, and replace orders
+- **Transaction History**: Retrieve account transactions and order history
+- **Market Analysis**: Find option strategies and view market movers
+
+### Integration with Claude Desktop
+
+Configure Claude Desktop to use this MCP server by adding it to your `claude_desktop_config.json`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+### Setting up for Development
+
+1. Clone the repository
+2. Run `bundle install` to install dependencies
+3. Copy `.env.example` to `.env` and configure your Schwab API credentials
+4. Run tests with `bundle exec rspec`
+5. Start the development server with `bundle exec exe/schwab_mcp`
+
+### Testing
+
+Run the test suite:
+
+```bash
+bundle exec rspec
+```
+
+### Code Quality
+
+The project uses RuboCop for code style enforcement:
+
+```bash
+bundle exec rubocop
+```
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jwplatta/schwab_mcp. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/jwplatta/schwab_mcp/blob/master/CODE_OF_CONDUCT.md).
+
+### How to Contribute
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b my-new-feature`)
+3. Make your changes and add tests
+4. Ensure all tests pass (`bundle exec rspec`)
+5. Run RuboCop to check code style (`bundle exec rubocop`)
+6. Commit your changes (`git commit -am 'Add some feature'`)
+7. Push to the branch (`git push origin my-new-feature`)
+8. Create a new Pull Request
+
+Please ensure your contributions:
+- Include appropriate tests
+- Follow the existing code style
+- Update documentation as needed
+- Respect the security considerations for financial API integration
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SchwabMcp project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/schwab_mcp/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/schwab_mcp

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require "schwab_mcp"
+require "dotenv/load"
+
+required_vars = [
+  'SCHWAB_API_KEY',
+  'SCHWAB_APP_SECRET',
+  'SCHWAB_CALLBACK_URI',
+  'TOKEN_PATH'
+]
+missing_vars = required_vars.select { |var| ENV[var].nil? || ENV[var].empty? }
+
+unless missing_vars.empty?
+  exit 1
+end
+
+
+SchwabMCP::Server.new.start

data/exe/schwab_token_refresh

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'pry'
+require 'dotenv'
+require 'schwab_rb'
+
+Dotenv.load
+
+required_vars = [
+  'SCHWAB_API_KEY',
+  'SCHWAB_APP_SECRET',
+  'SCHWAB_CALLBACK_URI',
+  'TOKEN_PATH'
+]
+missing_vars = required_vars.select { |var| ENV[var].nil? || ENV[var].empty? }
+
+unless missing_vars.empty?
+  puts "❌ Missing required environment variables: #{missing_vars.join(', ')}"
+  exit 1
+end
+
+token_path = ENV['TOKEN_PATH']
+puts "Token path: #{token_path}"
+
+begin
+  SchwabRb::Auth.init_client_easy(
+    ENV['SCHWAB_API_KEY'],
+    ENV['SCHWAB_APP_SECRET'],
+    ENV['SCHWAB_CALLBACK_URI'],
+    token_path
+  )
+  puts "✅ Token refresh completed successfully"
+rescue => e
+  puts "❌ Token refresh failed: #{e.message}"
+  exit 1
+end

data/exe/schwab_token_reset

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'pry'
+require 'dotenv'
+require 'schwab_rb'
+
+Dotenv.load
+
+required_vars = [
+  'SCHWAB_API_KEY',
+  'SCHWAB_APP_SECRET',
+  'SCHWAB_CALLBACK_URI',
+  'TOKEN_PATH'
+]
+missing_vars = required_vars.select { |var| ENV[var].nil? || ENV[var].empty? }
+
+unless missing_vars.empty?
+  puts "❌ Missing required environment variables: #{missing_vars.join(', ')}"
+  exit 1
+end
+
+token_path = ENV['TOKEN_PATH']
+puts "Token path: #{token_path}"
+
+if File.exist?(token_path)
+  puts "🗑️  Deleting existing token file: #{token_path}"
+  File.delete(token_path)
+  puts "✅ Token file deleted successfully"
+else
+  puts "ℹ️  Token file doesn't exist at: #{token_path}"
+end
+
+refresh_script_path = File.join(File.dirname(__FILE__), 'schwab_token_refresh')
+puts "🔄 Calling token refresh script: #{refresh_script_path}"
+
+begin
+  result = system(refresh_script_path)
+  if result
+    puts "✅ Token reset and refresh completed successfully"
+  else
+    puts "❌ Token refresh script failed"
+    exit 1
+  end
+rescue => e
+  puts "❌ Failed to execute token refresh script: #{e.message}"
+  exit 1
+end

data/lib/schwab_mcp/loggable.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "logger"
+
+module SchwabMCP
+  module Loggable
+    def logger
+      SchwabMCP::Logger
+    end
+
+    def log_debug(message)
+      logger.debug(message)
+    end
+
+    def log_info(message)
+      logger.info(message)
+    end
+
+    def log_warn(message)
+      logger.warn(message)
+    end
+
+    def log_error(message)
+      logger.error(message)
+    end
+
+    def log_fatal(message)
+      logger.fatal(message)
+    end
+  end
+end

data/lib/schwab_mcp/logger.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "logger"
+require "tmpdir"
+require_relative "redactor"
+
+module SchwabMCP
+  class Logger
+    @instance = nil
+
+    class << self
+      def instance
+        @instance ||= create_logger
+      end
+
+      def debug(message)
+        instance.debug(Redactor.redact_formatted_text(message)) if debug_enabled?
+      end
+
+      def info(message)
+        instance.info(Redactor.redact_formatted_text(message))
+      end
+
+      def warn(message)
+        instance.warn(Redactor.redact_formatted_text(message))
+      end
+
+      def error(message)
+        instance.error(Redactor.redact_formatted_text(message))
+      end
+
+      def fatal(message)
+        instance.fatal(Redactor.redact_formatted_text(message))
+      end
+
+      private
+
+      def create_logger
+        if ENV['LOGFILE'] && !ENV['LOGFILE'].empty?
+          max_size = (ENV['LOG_MAX_SIZE'] || 10 * 1024 * 1024).to_i
+          max_files = (ENV['LOG_MAX_FILES'] || 5).to_i
+          logger = ::Logger.new(ENV['LOGFILE'], max_files, max_size)
+        else
+          # When running as MCP server, don't log to stderr as it interferes with the protocol
+          # Use a default log file instead
+          default_log_file = File.join(Dir.tmpdir, 'schwab_mcp.log')
+          logger = ::Logger.new(default_log_file)
+        end
+
+        logger.level = debug_enabled? ? ::Logger::DEBUG : ::Logger::INFO
+        logger.formatter = proc do |severity, datetime, progname, msg|
+          "[#{datetime.strftime('%H:%M:%S')}] SCHWAB_MCP #{severity}: #{msg}\n"
+        end
+        logger
+      end
+
+      def debug_enabled?
+        ENV['DEBUG'] == 'true' || ENV['LOG_LEVEL'] == 'DEBUG'
+      end
+    end
+  end
+end