Merge pull request #187 from AgentOps-AI/tool-add-docs-clarify

tool add docs

Author: bboynton97

.github/workflows/mintlify-check.yml

@@ -18,33 +18,21 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: '18'
-          cache: 'npm'
 
       - name: Install Mintlify
         run: npm install -g mintlify
 
-      - name: Build documentation
+      - name: Test documentation
         run: |
           cd docs
-          mintlify build
-
-      - name: Check build status
-        run: |
-          if [ $? -eq 0 ]; then
-            echo "Documentation build successful!"
+          # If mintlify dev has errors, it will exit with status 1
+          # If it starts successfully, kill it after 5 seconds
+          timeout 5s mintlify dev || exit_status=$?
+          if [ $exit_status -eq 124 ]; then
+            # timeout exit code 124 means the process was killed after starting successfully
+            echo "Documentation built successfully!"
+            exit 0
           else
-            echo "Documentation build failed!"
+            echo "Documentation failed to build! Try running `mintlify dev` from the docs dir locally"
             exit 1
-          fi
-
-      - name: Comment on PR if build fails
-        if: failure()
-        uses: actions/github-script@v7
-        with:
-          script: |
-            github.rest.issues.createComment({
-              issue_number: context.issue.number,
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              body: '❌ Mintlify documentation build failed. Please check the build logs for details.'
-            })
+          fi

CONTRIBUTING.md

@@ -27,18 +27,7 @@ The best place to engage in conversation about your contribution is in the Issue
 ## Adding Tools
 If you're reading this section, you probably have a product that AI agents can use as a tool. We're glad you're here!
 
-Adding tools is easy once you understand the project structure. A few things need to be done for a tool to be considered completely supported:
-
-1. Modify `agentstack/tools/tools.json`
-   - Add your tool and relevant information to this file as appropriate.
-2. Create a config for your tool
-   - As an example, look at `mem0.json`
-   - AgentStack uses this to know what code to insert where. Follow the structure to add your tool.
-3. Create your implementation for each framework
-   - In `agentstack/templates/<framework>/tools`, you'll see other implementations of tools.
-   - Build your tool implementation for that framework. This file will be inserted in the user's project.
-   - The tools that are exported from this file should be listed in the tool's config json.
-4. Manually test your tool integration by running `agentstack tools add <your_tool>` and ensure it behaves as expected.
+Adding tools is easy once you understand the project structure. Our documentation for adding tools is available on our hosted docs [here](https://docs.agentstack.sh/contributing/adding-tools).
 
 ## Before creating your PR
 Be sure that you are opening a PR using a branch other than `main` on your fork. This enables us

agentstack/update.py

@@ -112,7 +112,7 @@ def check_for_updates(update_requested: bool = False):
     if not update_requested and not should_update():
         return
 
-    print("Checking for updates...\n")
+    print("Checking for updates...")
 
     try:
         latest_version: Version = get_latest_version(AGENTSTACK_PACKAGE)

docs/contributing/adding-tools.mdx

@@ -20,6 +20,7 @@ Adding tools is easy once you understand the project structure. A few things nee
   </Step>
   <Step title="Test your tool">
       Manually test your tool integration by running `agentstack tools add <your_tool>` and ensure it behaves as expected.
+      <Note>This must be done within an AgentStack project. To create your test project, run `agentstack init test_proj`, then `cd` into the project and try adding your tool.</Note>
   </Step>
   <Step title="Open a PR to add your tool to the next release">
   </Step>

docs/development.mdx

@@ -92,6 +92,4 @@ Repeat step 3.
     Try navigating to the root of your device and delete the ~/.mintlify folder.
     Then run `mintlify dev` again.
   </Accordion>
-</AccordionGroup>
-
-Curious about what changed in a CLI version? [Check out the CLI changelog.](/changelog/command-line)
+</AccordionGroup>