Skip to content

feat: add Terminal Markdown Display - #557

Merged
tusharmath merged 10 commits into
mainfrom
improve-descriptions
Mar 20, 2025
Merged

feat: add Terminal Markdown Display#557
tusharmath merged 10 commits into
mainfrom
improve-descriptions

Conversation

@tusharmath

Copy link
Copy Markdown
Collaborator

Overview

This PR improves tool documentation standards, adds a new ShowUser tool for rendering markdown in the terminal, enhances agent configuration options, and implements a better merge strategy for agent subscriptions.

Purpose

These changes aim to establish comprehensive documentation standards for tool descriptions, provide better user-facing output capabilities through markdown rendering, and give more control over agent visibility in the console. The work stems from the need to make tools more discoverable and properly utilized by AI agents while improving the user experience.

Implementation

The implementation includes:

  1. Documentation Standards: Added comprehensive guidelines and an improvement plan for tool descriptions
  2. ShowUser Tool: Created a new tool that renders markdown content in the terminal using termimad
  3. Agent Enhancements:
    • Added option to control agent visibility
    • Implemented custom merge strategy for agent subscriptions to properly combine events
  4. Refactoring:
    • Removed the obsolete "think" tool
    • Updated execute_tool to always return ToolResult
    • Consolidated tool registry for better organization

Testing

The changes include:

  • Unit tests for new functionality (ShowUser tool)
  • Tests for agent merge behavior with the new hide_content option
  • Tests for the custom subscription merge strategy
  • Updated API test execution condition to improve reliability

Related Issues

No explicit issue numbers are referenced in commits, but these changes address needs for:

  • Better tool discoverability and description
  • Enhanced terminal output capabilities
  • More flexible agent configuration
  • Improved subscription handling

Changelog

Added

  • New tool for formatting markdown in the terminal
  • Comprehensive documentation for tool description best practices (docs/tool-guidelines.md)
  • Tool description improvement plan (docs/tool-description-improvement-plan.md)
  • option for agents to control console visibility
  • Custom merge strategy for agent subscriptions

Changed

  • FSRead tool updated to use infrastructure file read service
  • Default agent configuration in forge.default.yaml
  • Agent system prompt to include user visibility section
  • execute_tool refactored to always return ToolResult

Removed

  • Obsolete "think" tool that is no longer needed

Suggested Reviewers

The changes touch both documentation and core functionality, so reviewers familiar with:

  1. The agent system architecture
  2. Terminal UI rendering
  3. Tool integration with AI models

are recommended to review this PR.

@github-actions github-actions Bot added type: docs Related to documentation and information. type: feature Brand new functionality, features, pages, workflows, endpoints, etc. labels Mar 19, 2025
@tusharmath
tusharmath force-pushed the improve-descriptions branch from 18d0815 to b98a8f1 Compare March 19, 2025 14:24
@CLAassistant

CLAassistant commented Mar 19, 2025

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

tusharmath and others added 4 commits March 19, 2025 20:58
- Enhance tool descriptions for better clarity and consistency
- Update descriptions for fetch, fs_find, fs_read, apply_json, shell, and show_user tools
- Remove the think.rs tool and its references in registry
- Make descriptions more concise and focused on tool purpose and usage

Co-authored-by: Forge <forge@antinomy.ai>
- Add partial-show-user.hbs template for consistent user visibility instructions
- Update model selection in default config
- Enhance help agent with display tool support
- Simplify system prompt templates

Co-authored-by: Forge <forge@antinomy.ai>
@tusharmath
tusharmath force-pushed the improve-descriptions branch from cc9144d to e637580 Compare March 19, 2025 15:28
@tusharmath tusharmath changed the title feat: Improve Tool Documentation, Add Terminal Markdown Display, and Enhance Agent Configuration fix: Improve Tool Documentation, Add Terminal Markdown Display, and Enhance Agent Configuration Mar 19, 2025
@tusharmath
tusharmath enabled auto-merge (squash) March 19, 2025 15:29
autofix-ci Bot and others added 3 commits March 20, 2025 03:28
This change improves the user experience by showing relative file paths
instead of absolute paths when displaying which files are being read,
making the output cleaner and more readable.

- Added format_display_path method to convert absolute paths to relative when possible
- Modified execute method to use the new function for display
- Added appropriate test for the new functionality

Co-authored-by: Forge <forge@antinomy.ai>
Add hide_content: true to help_agent, git-commit, and github-pull-request-create agents.
Also fix ordering of id and tool_supported in software-engineer agent.

Co-authored-by: Forge <forge@antinomy.ai>
@tusharmath tusharmath changed the title fix: Improve Tool Documentation, Add Terminal Markdown Display, and Enhance Agent Configuration feat: improve add Terminal Markdown Display Mar 20, 2025
@tusharmath tusharmath changed the title feat: improve add Terminal Markdown Display feat: add Terminal Markdown Display Mar 20, 2025
No longer needed in CI configuration as tests are managed through other mechanisms.

Co-authored-by: Forge <forge@antinomy.ai>
@tusharmath
tusharmath merged commit 87c191e into main Mar 20, 2025
@amitksingh1490
amitksingh1490 deleted the improve-descriptions branch October 1, 2025 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: docs Related to documentation and information. type: feature Brand new functionality, features, pages, workflows, endpoints, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants