HallD commited on
Commit
6bdd68c
·
1 Parent(s): 42f958c

Readme video link added and codegen prompt updated

Browse files
Files changed (2) hide show
  1. README.md +22 -1
  2. app.py +10 -2
README.md CHANGED
@@ -53,6 +53,10 @@ However, if additional packages are required, this will be installed prior to ex
53
 
54
  Once executed the whole process is summarised and returned to the user.
55
 
 
 
 
 
56
  ## Key information
57
 
58
  I've found that whilst using VS Code for the MCP interaction, its useful to type the main agent function name to ensure the right tool is picked.
@@ -62,7 +66,8 @@ For example "agent research request: How do you write a python script to perform
62
  This is the JSON script required to set up the MCP in VS Code
63
 
64
  ```json
65
- {"mcp": {
 
66
  "inputs": [],
67
  "servers": {
68
  "gradiocodeassist": {
@@ -75,6 +80,22 @@ This is the JSON script required to set up the MCP in VS Code
75
  }
76
  }
77
  ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
78
 
79
  ## ✨ Key Features
80
 
 
53
 
54
  Once executed the whole process is summarised and returned to the user.
55
 
56
+ ---
57
+ Here is a link to the video demonstration [MCP Demo Shallow Research Code Assistant](https://www.loom.com/share/ea4584bc76c04adabefd6d39a4f8e279?sid=5d2408ff-03d1-421b-b956-9713ae390212)
58
+ ---
59
+
60
  ## Key information
61
 
62
  I've found that whilst using VS Code for the MCP interaction, its useful to type the main agent function name to ensure the right tool is picked.
 
66
  This is the JSON script required to set up the MCP in VS Code
67
 
68
  ```json
69
+ {
70
+ "mcp": {
71
  "inputs": [],
72
  "servers": {
73
  "gradiocodeassist": {
 
80
  }
81
  }
82
  ```
83
+ This is the JSON script required to set up the MCP Via Cline in VS Code
84
+
85
+ ```json
86
+ {
87
+ "mcpServers": {
88
+ "gradiocodeassist": {
89
+ "autoApprove": [],
90
+ "disabled": false,
91
+ "timeout": 300,
92
+ "type": "sse",
93
+ "url": "https://agents-mcp-hackathon-shallowcoderesearch.hf.space/gradio_api/mcp/sse",
94
+ "headers": {}
95
+ }
96
+ }
97
+ }
98
+ ```
99
 
100
  ## ✨ Key Features
101
 
app.py CHANGED
@@ -717,13 +717,21 @@ class CodeGeneratorAgent:
717
  # ✅ Good way to show a dict:
718
  print("The data is:", my_dict)
719
 
 
 
 
 
 
 
 
 
720
  ### **Summary**
721
 
722
  - Repeat the "NEVER wrap dicts/lists in f-strings" rule.
723
  - Use all-caps or bold/emoji to make "NEVER" and "ALWAYS" pop out.
724
  - Finish the prompt by *repeating* the most important style rule.
725
- - Never include backticks or the word "python" in the response.
726
- - Return only the actual code as a string without any additional text.
727
  """
728
 
729
  @with_performance_tracking("code_generation")
 
717
  # ✅ Good way to show a dict:
718
  print("The data is:", my_dict)
719
 
720
+ Generated code like this is stricly forbidden due to the word python and the backticks
721
+ ```python
722
+ import x
723
+ import y
724
+ def my_function(i):
725
+ return i + 1
726
+ ```
727
+
728
  ### **Summary**
729
 
730
  - Repeat the "NEVER wrap dicts/lists in f-strings" rule.
731
  - Use all-caps or bold/emoji to make "NEVER" and "ALWAYS" pop out.
732
  - Finish the prompt by *repeating* the most important style rule.
733
+ - **NEVER** include backticks like this ` or the word "python" in the response.
734
+ - Return **ONLY** the actual code as a string without any additional text.
735
  """
736
 
737
  @with_performance_tracking("code_generation")