-
Notifications
You must be signed in to change notification settings - Fork 60
.github: add rust instructions for copilot #71
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| --- | ||
| applyTo: "**/*.rs" | ||
| --- | ||
|
|
||
| # Project overview | ||
|
|
||
| This project is a ModelContextProtocol (MCP) server implementation that runs Tools as WebAssembly (Wasm) components using the Wasmtime engine. | ||
|
|
||
| View the design/architecture.md for a high-level overview of the architecture and docs for detailed documentations. | ||
|
|
||
| ## Best practices | ||
|
|
||
| - Single responsibility principle: ensure each function and struct has a single, well-defined purpose. | ||
| - DRY (Don't Repeat Yourself): avoid code duplication by extracting common logic into reusable functions or modules. | ||
| - Descriptive naming: use clear, descriptive names for functions, variables, and types to improve code readability. | ||
| - Include unit tests for all public functions and modules to verify correctness and handle edge cases. | ||
| - Keep it simple: avoid unnecessary complexity in code and design. Favor straightforward solutions that are easy to understand and maintain. | ||
| - Manage dependencies carefully: use `Cargo.toml` to manage dependencies and keep them up-to-date. Avoid unnecessary dependencies that bloat the project. | ||
| - Idiomatic error handling: Use `anyhow` for error handling to provide context and stack traces. | ||
| - Write idiomatic Rust code that passes `cargo clippy` warnings. | ||
| - Use traits to define shared behavior and generics to create reusable, type-safe components. Design the API to be extensible | ||
| - Use stdlib primitives like `Arc` and `Mutex` for thread safety and shared state. | ||
| - Choose appropriate data types like `&str` over `String` for performance and memory efficiency. | ||
|
|
||
| ## Debugging | ||
|
|
||
|
|
||
| You can use commands in the Justfile to start the wassette mcp server (`just run`) and to run the tests (`just test`). `just run` will start the server that listens to "127.0.0.1:9001/sse". | ||
|
|
||
| Then you can use `npx @modelcontextprotocol/inspector` to connect to the server and inspect the state of the MCP server. | ||
|
|
||
| The following is a list of sample CLI commands you can use to interact with the MCP server: | ||
|
|
||
| ```bash | ||
| # Connect to a remote MCP server (default is SSE transport) | ||
| npx @modelcontextprotocol/inspector --cli http://127.0.0.1:9001/sse | ||
|
|
||
| # List tools from a remote server | ||
| npx @modelcontextprotocol/inspector --cli http://127.0.0.1:9001/sse --method tools/list | ||
|
|
||
| # Call a tool on a remote server | ||
| npx @modelcontextprotocol/inspector --cli http://127.0.0.1:9001/sse --method tools/call --tool-name remotetool --tool-arg param=value | ||
| ``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.