Skip to content

Commit e219d52

Browse files
ExcoriateExcoriate
authored
docs: add better issue templates (#2)
* fix: correct env fallback logic in getConfig() Fix logic in getConfig() that handled fallback for the "ENV" and "TIMEOUT" variables. Previously, if the environment variable was set but empty, the config incorrectly retained the default value rather than using the empty override. Updated the conditional checks in getConfig() to explicitly test for environment variables with non-empty values before overriding the defaults. This change ensures consistent and predictable configuration behavior even when environment variables are explicitly set to empty strings. Affected files: - cmd/main.go No functional changes to the init or apply logic, but all existing unit tests pass and coverage is unchanged. This fix removes subtle misbehavior when deploying in CI environments with empty but defined environment variables. No breaking changes introduced. * feat: Add branch labeling rules to GitHub Actions Add new branch labeling rules to the GitHub Actions labeler configuration file. This allows automatically labeling pull requests and issues based on the branch name prefix. The new rules include: - `feature`: Label branches starting with `feature` or `feature/` - `fix`: Label branches starting with `fix` or `fix/` - `ci`: Label branches starting with `ci` or `ci/` - `refactor`: Label branches starting with `refactor` or `refactor/` These labels will help categorize and organize contributions, making it easier to track the type of changes being made to the codebase. Affected files: - .github/labeler.yml The existing patch labeling rules have also been updated to use the new `changed-files` syntax, which provides more flexibility in matching file patterns. No functional changes to the application code. This is purely an enhancement to the GitHub Actions workflow configuration. No breaking changes introduced. * refactor: simplify labeler configuration Simplify the .github/labeler.yml configuration by consolidating common file patterns into single entries. This reduces duplication and makes the configuration more concise and easier to maintain. The key changes are: - Combine all .github/workflows/* patterns into a single entry - Combine all *.md file patterns into a single entry - Combine all .github/* configuration file patterns into a single entry - Combine all .env, .gitignore, and .gitattributes patterns into a single entry These changes do not alter the actual labeling behavior, but make the configuration more readable and maintainable going forward. Affected files: - .github/labeler.yml No functional changes, only refactoring the configuration structure. All existing label assignments should remain unchanged. No breaking changes introduced. * docs: Add MCP debugging documentation feat: Implement MCP debugging tools and workflows The commit adds a new documentation file "Debugging - Model Context Protocol.md" that provides a comprehensive guide on debugging MCP servers and integrations. The key changes include: - Introduce the main debugging tools available in the MCP ecosystem: MCP Inspector, Claude Desktop Developer Tools, and server-side logging. - Describe how to use the debugging features in Claude Desktop, including checking server status, viewing logs, and using Chrome DevTools. - Outline common issues developers may encounter, such as working directory problems, environment variable issues, and server initialization errors. - Explain how to implement effective logging strategies on the server and client side. - Provide a recommended debugging workflow, covering initial development, integration testing, and efficient testing of changes. - Highlight best practices for logging, error handling, performance tracking, and security considerations. - Offer guidance on getting help and next steps when encountering issues. The goal of this change is to equip MCP users and contributors with a detailed reference on debugging techniques and tools to support the development and integration of MCP-based applications. The documentation follows the Linux kernel's commit message style, providing a clear, concise, and comprehensive overview of the changes.
1 parent 6ad5cbf commit e219d52

25 files changed

+532
-364
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 94 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
name: "🐛 Bug Report"
3+
description: Report a bug in the MCP AWS Provider Docs server
4+
title: "(module name): (short issue description)"
5+
labels: [bug, needs-triage]
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: Describe the bug
11+
description: What is the problem? A clear and concise description of the bug in the context of the MCP server, AWS provider, or Terragrunt documentation.
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: expected
16+
attributes:
17+
label: Expected Behavior
18+
description: What did you expect to happen?
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: current
23+
attributes:
24+
label: Current Behavior
25+
description: What actually happened? Include errors, stack traces, and relevant logs.
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: reproduction
30+
attributes:
31+
label: Reproduction Steps
32+
description: Provide a minimal code sample or repo to reproduce the issue (preferably related to Deno, TypeScript, or Terragrunt).
33+
validations:
34+
required: true
35+
- type: textarea
36+
id: solution
37+
attributes:
38+
label: Possible Solution
39+
description: Suggest a fix or reason for the bug.
40+
validations:
41+
required: false
42+
- type: textarea
43+
id: context
44+
attributes:
45+
label: Additional Information/Context
46+
description: Anything else that might be relevant for troubleshooting this bug.
47+
validations:
48+
required: false
49+
- type: input
50+
id: operating-system
51+
attributes:
52+
label: OS
53+
validations:
54+
required: true
55+
- type: input
56+
id: server-version
57+
attributes:
58+
label: Server Version
59+
validations:
60+
required: true
61+
- type: input
62+
id: mcp-tool
63+
attributes:
64+
label: MCP Tool
65+
description: Specify which MCP tool you are using
66+
validations:
67+
required: true
68+
- type: checkboxes
69+
id: code-of-conduct
70+
attributes:
71+
label: Code of Conduct
72+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://aws.github.io/code-of-conduct).
73+
options:
74+
- label: I agree to follow this project's Code of Conduct
75+
required: true

‎.github/ISSUE_TEMPLATE/documentation.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: "📕 Documentation Issue"
3+
description: Report an issue in the API Reference documentation or Developer Guide for the MCP AWS Provider Docs server
4+
title: "(module name): (short issue description)"
5+
labels: [documentation, needs-triage]
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: Describe the documentation issue
11+
description: A clear and concise description of the documentation problem (missing, incorrect, unclear, etc.).
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: links
16+
attributes:
17+
label: Links
18+
description: Include links to affected documentation page(s) or code references.
19+
validations:
20+
required: true
21+
- type: checkboxes
22+
attributes:
23+
label: Code of Conduct
24+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://aws.github.io/code-of-conduct).
25+
options:
26+
- label: I agree to follow this project's Code of Conduct
27+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 63 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
name: 🚀 Feature Request
3+
description: Suggest an idea for the MCP AWS Provider Docs server
4+
title: "(module name): (short issue description)"
5+
labels: [feature, needs-triage]
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: Describe the feature
11+
description: A clear and concise description of the feature you are proposing for the MCP server, AWS provider, or Terragrunt documentation.
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: use-case
16+
attributes:
17+
label: Use Case
18+
description: Why do you need this feature? What problem does it solve for users of the MCP server or Terragrunt documentation?
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: solution
23+
attributes:
24+
label: Proposed Solution
25+
description: Suggest how to implement the addition or change. Please include prototype/workaround/sketch/reference implementation.
26+
validations:
27+
required: false
28+
- type: textarea
29+
id: other
30+
attributes:
31+
label: Other Information
32+
description: Any alternative solutions or features you considered, a more detailed explanation, stack traces, related issues, links for context, etc.
33+
validations:
34+
required: false
35+
- type: checkboxes
36+
id: ack
37+
attributes:
38+
label: Acknowledgements
39+
options:
40+
- label: I may be able to implement this feature request
41+
required: false
42+
- label: This feature might incur a breaking change
43+
required: false
44+
- type: checkboxes
45+
attributes:
46+
label: Code of Conduct
47+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://aws.github.io/code-of-conduct).
48+
options:
49+
- label: I agree to follow this project's Code of Conduct
50+
required: true

‎.github/ISSUE_TEMPLATE/rfc.yml

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
name: 🚧 Request for Comments (RFC)
2+
description: Feature design and detailed proposals for the MCP AWS Provider Docs server
3+
title: "RFC: TITLE"
4+
labels: ["RFC-proposal", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for submitting a RFC. Please add as many details as possible to help further enrich this design.
10+
- type: input
11+
id: relation
12+
attributes:
13+
label: Is this related to an existing feature request or issue?
14+
description: Please share a link, if applicable
15+
- type: textarea
16+
id: summary
17+
attributes:
18+
label: Summary
19+
description: Please provide an overview in one or two paragraphs
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: problem
24+
attributes:
25+
label: Use case
26+
description: Please share the use case and motivation behind this proposal, especially as it relates to the MCP server, AWS provider, or Terragrunt documentation.
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: proposal
31+
attributes:
32+
label: Proposal
33+
description: Please explain the design in detail, so anyone familiar with the project could implement it
34+
placeholder: What the user experience looks like before and after this design?
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: scope
39+
attributes:
40+
label: Out of scope
41+
description: Please explain what should be considered out of scope in your proposal
42+
validations:
43+
required: true
44+
- type: textarea
45+
id: challenges
46+
attributes:
47+
label: Potential challenges
48+
description: Please share what common challenges, edge cases, unresolved areas, and suggestions on how to mitigate them
49+
validations:
50+
required: true
51+
- type: textarea
52+
id: integrations
53+
attributes:
54+
label: Dependencies and Integrations
55+
description: If applicable, please share whether this feature has additional dependencies, and how it might integrate with other utilities available
56+
validations:
57+
required: false
58+
- type: textarea
59+
id: alternatives
60+
attributes:
61+
label: Alternative solutions
62+
description: Please describe what alternative solutions to this use case, if any
63+
render: markdown
64+
validations:
65+
required: false
66+
- type: checkboxes
67+
attributes:
68+
label: Code of Conduct
69+
description: By submitting this RFC, you agree to follow our [Code of Conduct](https://aws.github.io/code-of-conduct).
70+
options:
71+
- label: I agree to follow this project's Code of Conduct
72+
required: true

0 commit comments

Comments
 (0)