Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.

Fixes # (issue)

## Type of change

Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

## How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.

## Checklist:

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules
Binary file added .github/resources/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 27 additions & 0 deletions .gitmessage
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# <type>: <subject>
# |<---- Using a maximum of 50 characters ---->|

# Explain why this change is being made
# |<---- Try to limit each line to a maximum of 72 characters ---->|

# Provide links to any relevant tickets, issues, or other resources
# Example: Resolves: #123
# See: #456, #789

# --- COMMIT END ---
# Type can be
# feat (new feature)
# fix (bug fix)
# refactor (refactoring code)
# style (formatting, missing semicolons, etc; no code change)
# docs (changes to documentation)
# test (adding or refactoring tests; no production code change)
# chore (updating grunt tasks etc; no production code change)
# --------------------
# Remember to
# Use the imperative mood in the subject line
# Do not end the subject line with a period
# Separate subject from body with a blank line
# Use the body to explain what and why vs. how
# Can use multiple lines with "-" for bullet points in body
# --------------------
90 changes: 90 additions & 0 deletions .golangci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
run:
timeout: 5m
modules-download-mode: readonly
allow-parallel-runners: true
go: '1.24'

output:
format: colored-line-number
sort-results: true

linters-settings:
revive:
rules:
- name: exported
severity: warning
disabled: false
arguments:
- checkPrivateReceivers
- sayRepetitiveInsteadOfStutters
- name: unexported-return
severity: warning
disabled: false
- name: unused-parameter
severity: warning
disabled: false
govet:
check-shadowing: true
gocyclo:
min-complexity: 15
dupl:
threshold: 100
goconst:
min-len: 2
min-occurrences: 3
misspell:
locale: US
goimports:
local-prefixes: github.com/f/mcptools
gofumpt:
extra-rules: true
nolintlint:
allow-unused: false
require-explanation: true
require-specific: true

linters:
disable-all: true
enable:
- bodyclose
- dogsled
- dupl
- errcheck
- exportloopref
- goconst
- gocritic
- gocyclo
- gofmt
- gofumpt
- goimports
- gosec
- gosimple
- govet
- ineffassign
- misspell
- nakedret
- noctx
- nolintlint
- revive
- staticcheck
- stylecheck
- typecheck
- unconvert
- unused

issues:
exclude-rules:
- path: _test\.go
linters:
- dupl
- gosec
- gomnd
- path: pkg/jsonutils
linters:
- dupl
- path: cmd/mcptools/main.go
linters:
- gocyclo
max-issues-per-linter: 0
max-same-issues: 0
fix: false
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@

A command-line interface for interacting with MCP (Model Context Protocol) servers using both stdio and HTTP transport.

## Overview

```bash
mcp shell npx -y @modelcontextprotocol/server-filesystem ~/Code
```

This will open a shell as following:

![MCP Tools Screenshot](.github/resources/screenshot.png)

## Installation

### Using Homebrew
Expand Down
Loading