Commit Graph

39 Commits

Author SHA1 Message Date
Adam Jones
350ffeec01 Fix VS Code MCP documentation URLs
Update links to point to the new location at /docs/copilot/customization/mcp-servers
2025-11-25 22:11:56 +00:00
Valeriy Pavlovich
84c2824f03 # feat(filesystem): add ToolAnnotations hints to filesystem tools (#3045)
**Files touched**

- [src/filesystem/index.ts](../blob/HEAD/src/filesystem/index.ts) — add `annotations` metadata to each tool definition
- [src/filesystem/README.md](../blob/HEAD/src/filesystem/README.md) — document ToolAnnotations mapping for all filesystem tools

## Description

This change adds MCP `ToolAnnotations` (`readOnlyHint`, `idempotentHint`, `destructiveHint`) to all filesystem tools and documents the mapping in the filesystem README. MCP clients can now accurately distinguish read‑only vs. write tools, understand which operations are safe to retry, and highlight potentially destructive actions.

## Server Details

- **Server**: filesystem
- **Area**: tools (metadata returned via `listTools` / `ListToolsRequest`) and server docs

## Motivation and Context

Previously, the filesystem server did not expose ToolAnnotations, so many clients (e.g. ChatGPT Apps) conservatively treated filesystem tools as generic write operations. This led to:

- READ operations being surfaced with WRITE badges and confirmation prompts.
- No way for clients to know which write tools are idempotent or potentially destructive.

This PR aligns the implementation with `servers#2988` and updates the README to clearly document the semantics of each tool. Read‑only operations no longer need to be treated as writes, and destructive/idempotent behavior is explicit for UI and retry logic.

## How Has This Been Tested?

- `npm run build --workspace @modelcontextprotocol/server-filesystem`
- `npm test --workspaces --if-present`

## Breaking Changes

None.

## Types of changes

- [ ] Bug fix (non-breaking change which fixes an issue)
- [x] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
- [x] Documentation update

## Checklist

- [x] I have read the [MCP Protocol Documentation](https://modelcontextprotocol.io)
- [x] My changes follows MCP security best practices
- [x] I have updated the server's README accordingly
- [x] I have tested this with an LLM client
- [x] My code follows the repository's style guidelines
- [x] New and existing tests pass locally
- [x] I have added appropriate error handling
- [ ] I have documented all environment variables and configuration options

## Additional context

None.

Co-authored-by: Valeriy_Pavlovich <vp@strato.space>
2025-11-24 15:58:15 +00:00
多吃点
097fdab463 docs: Fix duplicate directory_tree tool entry in API documentation 2025-09-13 13:00:02 +08:00
Finn Andersen
fd886fac9c Support glob pattern in search_files tool (#745)
Co-authored-by: Adam Jones <adamj+git@anthropic.com>
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Adam Jones <adamj@anthropic.com>
2025-08-23 07:37:53 +01:00
Enrico Ballardini
d381cf1ffd feat(directory_tree): add excludePatterns support & documentation (#623)
- Update documentation with directory_tree declaration
- Add excludePatterns parameter to DirectoryTreeArgsSchema
- Implement pattern exclusion in buildTree function using minimatch
- Pass excludePatterns through recursive calls
- Support both simple and glob patterns for exclusion
- Maintain consistent behavior with search_files implementation

* Add tests and fix implementation

---------

Co-authored-by: Ola Hungerford <olahungerford@gmail.com>
Co-authored-by: Adam Jones <adamj+git@anthropic.com>
Co-authored-by: Adam Jones <adamj@anthropic.com>
2025-08-23 07:19:01 +01:00
Michael Casazza
46368832ef Windows filesystem MCP enhancements (#543)
* fix: comprehensive Windows path handling improvements

- Add path-utils module for consistent path handling
- Handle Windows paths with spaces via proper quoting
- Support Unix-style Windows paths (/c/path)
- Support WSL paths (/mnt/c/path)
- Add comprehensive test coverage
- Fix path normalization for all path formats

Closes #447

* tested locally and working now

* Add filesystem path utils and tests

* Ensure Windows drive letters are capitalized in normalizePath

* adding test for gh pr comment

* pushing jest and windows testing config

* last commit? fixing comments on PR

* Fix bin and bump sdk

* Remove redundant commonjs version of path-utils and import from ts version

* Remove copying cjs file

* Remove copying run-server

* Remove complex args parsing and do other cleanup

* Add missing tools details to Readme

* Move utility functions from index to lib

* Add more tests and handle very small and very large files edge cases

* Finish refactoring and include original security fix comments

* On Windows, also check for drive root

* Check symlink support on restricted Windows environments

* Fix tests

* Bump SDK and package version

* Clean up

---------

Co-authored-by: olaservo <olahungerford@gmail.com>
Co-authored-by: adam jones <adamj+git@anthropic.com>
2025-08-18 18:23:40 +01:00
claude[bot]
54f9c6968e fix: remove incorrect resources claim from filesystem server README
The filesystem server does not actually implement MCP Resources capability
but the README incorrectly claimed it provides 'file://system' resource interface.

Fixes #399

Co-authored-by: Ola Hungerford <olaservo@users.noreply.github.com>
2025-08-17 16:38:29 +00:00
Ola Hungerford
1028b32573 Merge pull request #2328 from kunalbabre/main
docs: Update VS Code installation instructions to use mcp.json for issue  #2320
2025-08-07 07:28:32 -07:00
Sampath Vuyyuru
a688cca947 Update src/filesystem/README.md
Fix broken link to Roots
2025-07-26 18:09:30 +00:00
Cliff Hall
2feb7cbaa5 Update src/filesystem/README.md
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
2025-07-18 16:03:22 -04:00
Cliff Hall
d532a5846d Stream media file reads 2025-07-18 14:18:32 -04:00
Cliff Hall
11a064c359 Rename read_file to read_text_file and add read_media_file 2025-07-18 13:42:56 -04:00
Kunal Babre
55a36ad0dd docs: Clean up VS Code installation instructions
- Remove unnecessary explanatory note about JSON format
- JSON examples already demonstrate the correct format clearly
- Streamlines documentation to focus on essential information
- Maintains reference to official VS Code MCP documentation

The removed note was redundant since both configuration methods 
use identical JSON structure shown in the examples.
2025-07-11 22:53:13 -07:00
Kunal Babre
95a72b792f docs: Add reference to official VS Code MCP documentation
- Add link to official VS Code MCP documentation in all server READMEs
- Enhances existing VS Code installation instructions with authoritative reference
- Provides users with comprehensive documentation for advanced configuration
- Complements the existing two-method approach with additional resources

Affects: everything, filesystem, git, memory, sequentialthinking
2025-07-11 22:45:10 -07:00
Kunal Babre
20eb59590e docs: Update VS Code installation instructions to use mcp.json
- Replace outdated 'Preferences: Open Settings (JSON)' instructions
- Add proper guidance for 'MCP: Open User Configuration' command
- Update JSON examples to remove mcp wrapper key
- Clarify user vs workspace configuration methods
- Fixes issue with outdated documentation across all servers

Affects: sequentialthinking, filesystem, memory, everything, git
2025-07-11 21:36:21 -07:00
Nandha Reddy
f3891aaf69 Apply suggestions from code review comments on docs and logging
Co-authored-by: Ola Hungerford <olahungerford@gmail.com>
2025-07-02 09:44:16 +10:00
Nandha Reddy
f8dd74576b feat(filesystem): implement MCP roots protocol for dynamic directory management
- Extract roots processing logic from index.ts into testable roots-utils.ts module and add Test suite
- Update README to recommend MCP roots protocol for dynamic directory management
2025-07-02 09:44:16 +10:00
Nandha Reddy
b37da40003 feat(filesystem): implement MCP roots protocol for dynamic directory management
- Add support for dynamic directory updates via MCP roots protocol
- Allow clients to override command-line directories at runtime
- Maintain backwards compatibility with existing command-line args
- Add comprehensive error handling for edge cases
- Update documentation to explain both configuration methods

Fixes #401
2025-07-02 09:43:25 +10:00
Burke Holland
090b6b7c1a Move VS Code below Claude 2025-04-10 12:10:02 -05:00
Burke Holland
e6db372447 Update READMEs with instructions for VS Code installation 2025-04-03 16:37:27 -05:00
Shotaro Sano
089b7f9abe Fix misleading edit_file functionality docs in filesystem README 2025-02-03 12:00:41 +09:00
freiit
0cf470e846 "," after last element of JSON object removed. 2025-01-17 11:09:24 +01:00
colinmcneil
49044156e3 Update readmes to use new mcp namespace 2024-12-19 13:11:36 -08:00
colinmcneil
545103386f Update filesystem config for Docker 2024-12-19 13:11:35 -08:00
colinmcneil
c64f8de15f Config tweaks for docker
- Remove `$` interpolation for env
- Allow puppeteer to work headless in docker, headful with npx
2024-12-19 13:11:35 -08:00
colinmcneil
bb0adaafd8 Allow filesystem to accept DOCKER_ROOT_WORKSPACE 2024-12-19 13:11:35 -08:00
Jim Clark
368e3b23ca Add Dockerfiles for the 17 sample MCP servers
* add Dockerfiles and update README.md definitions
2024-12-19 13:11:34 -08:00
Jeffrey Ling
da695fe05a cleanup diffs and improve glob matching 2024-12-06 17:37:39 -07:00
devin-ai-integration[bot]
4e08779cb5 docs: update README with excludePatterns documentation for search_files 2024-12-06 21:42:25 +00:00
Marc Goodner
7417d4dc07 update read me for current impl 2024-12-04 20:51:39 -08:00
Marc Goodner
de49769034 limitations added to readme 2024-12-03 08:51:01 -08:00
Marc Goodner
da0ef81067 update readme 2024-12-03 07:21:59 -08:00
Marc Goodner
9f2a77e044 updated readme 2024-12-02 17:43:17 -08:00
Rahim Nathwani
a54651477c Fix missing mcpServers keys in README code examples 2024-11-25 20:04:06 -08:00
Mahesh Murag
a1120c307b README Cleanup (#30) 2024-11-24 03:27:08 +00:00
Justin Spahr-Summers
7238146c2a Update all example configs 2024-11-21 19:41:32 +00:00
Zachary Lee
cc4d673ba4 Update README.md for filesystem
removed duplicate argument
2024-11-21 11:28:08 -05:00
Mahesh Murag
18edebe3c2 Added README 2024-11-20 23:34:00 -05:00
Mahesh Murag
3ded1f161d Updated Filesystem 2024-11-20 22:32:38 -05:00